createEventSubscription method

Future<CreateEventSubscriptionResult> createEventSubscription({ required String snsTopicArn, required String subscriptionName, bool? enabled, List<String>? eventCategories, String? severity, List<String>? sourceIds, String? sourceType, List<Tag>? tags, })

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon 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 source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

May throw EventSubscriptionQuotaExceededFault. May throw SubscriptionAlreadyExistFault. May throw SNSInvalidTopicFault. May throw SNSNoAuthorizationFault. May throw SNSTopicArnNotFoundFault. May throw SubscriptionEventIdNotFoundFault. May throw SubscriptionCategoryNotFoundFault. May throw SubscriptionSeverityNotFoundFault. May throw SourceNotFoundFault. May throw TagLimitExceededFault. May throw InvalidTagFault.

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

Parameter subscriptionName : The name of the event subscription to be created.

Constraints:

• Cannot be null, empty, or blank.
• Must contain from 1 to 255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Parameter enabled : A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

Parameter eventCategories : Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security

Parameter severity : Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

Parameter sourceIds : A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

Parameter sourceType : The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

Parameter tags : A list of tag instances.

Implementation

Future<CreateEventSubscriptionResult> createEventSubscription({
  required String snsTopicArn,
  required String subscriptionName,
  bool? enabled,
  List<String>? eventCategories,
  String? severity,
  List<String>? sourceIds,
  String? sourceType,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(snsTopicArn, 'snsTopicArn');
  _s.validateStringLength(
    'snsTopicArn',
    snsTopicArn,
    0,
    2147483647,
    isRequired: true,
  );
  ArgumentError.checkNotNull(subscriptionName, 'subscriptionName');
  _s.validateStringLength(
    'subscriptionName',
    subscriptionName,
    0,
    2147483647,
    isRequired: true,
  );
  _s.validateStringLength(
    'severity',
    severity,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'sourceType',
    sourceType,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  $request['SnsTopicArn'] = snsTopicArn;
  $request['SubscriptionName'] = subscriptionName;
  enabled?.also((arg) => $request['Enabled'] = arg);
  eventCategories?.also((arg) => $request['EventCategories'] = arg);
  severity?.also((arg) => $request['Severity'] = 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: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateEventSubscriptionMessage'],
    shapes: shapes,
    resultWrapper: 'CreateEventSubscriptionResult',
  );
  return CreateEventSubscriptionResult.fromXml($result);
}