createEventSubscription method

Future<CreateEventSubscriptionResult> createEventSubscription({
  1. required String snsTopicArn,
  2. required String subscriptionName,
  3. bool? enabled,
  4. List<String>? eventCategories,
  5. List<String>? sourceIds,
  6. String? sourceType,
  7. List<Tag>? tags,
})

Creates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

May throw EventSubscriptionQuotaExceededFault. May throw SubscriptionAlreadyExistFault. May throw SNSInvalidTopicFault. May throw SNSNoAuthorizationFault. May throw SNSTopicArnNotFoundFault. May throw SubscriptionCategoryNotFoundFault. May throw SourceNotFoundFault.

Parameter snsTopicArn : The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Parameter subscriptionName : The name of the subscription.

Constraints: The name must be less than 255 characters.

Parameter enabled : A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Parameter eventCategories : A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Parameter sourceIds : The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.
  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Parameter sourceType : The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Implementation

Future<CreateEventSubscriptionResult> createEventSubscription({
  required String snsTopicArn,
  required String subscriptionName,
  bool? enabled,
  List<String>? eventCategories,
  List<String>? sourceIds,
  String? sourceType,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(snsTopicArn, 'snsTopicArn');
  ArgumentError.checkNotNull(subscriptionName, 'subscriptionName');
  final $request = <String, dynamic>{};
  $request['SnsTopicArn'] = snsTopicArn;
  $request['SubscriptionName'] = subscriptionName;
  enabled?.also((arg) => $request['Enabled'] = arg);
  eventCategories?.also((arg) => $request['EventCategories'] = arg);
  sourceIds?.also((arg) => $request['SourceIds'] = arg);
  sourceType?.also((arg) => $request['SourceType'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreateEventSubscription',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateEventSubscriptionMessage'],
    shapes: shapes,
    resultWrapper: 'CreateEventSubscriptionResult',
  );
  return CreateEventSubscriptionResult.fromXml($result);
}