AWS CDK Reference

Appearance

v2.275.0

CfnEventSubscriptionProps Struct ​

Properties for defining a CfnEventSubscription.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnEventSubscriptionProps: dms.CfnEventSubscriptionProps = {
  snsTopicArn: 'snsTopicArn',

  // the properties below are optional
  enabled: false,
  eventCategories: ['eventCategories'],
  sourceIds: ['sourceIds'],
  sourceType: 'sourceType',
  subscriptionName: 'subscriptionName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{}#
Indicates whether to activate the subscription.

If you don't specify this property, CloudFormation activates the subscription.

eventCategoriesoptionalstring[]event_categoriesoptionaltyping.List[str]eventCategoriesoptionalList<String>EventCategoriesoptionalstring[]EventCategoriesoptional*[]*string#
A list of event categories for a source type that you want to subscribe to.
notes

If you don't specify this property, you are notified about all event categories. For more information, see Working with Events and Notifications in the AWS DMS User Guide .

snsTopicArnstringsns_topic_arnstrsnsTopicArnStringSnsTopicArnstringSnsTopicArn*stringrequired#
The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.

The ARN is created by Amazon SNS when you create a topic and subscribe to it.

sourceIdsoptionalstring[]source_idsoptionaltyping.List[str]sourceIdsoptionalList<String>SourceIdsoptionalstring[]SourceIdsoptional*[]*string#
A list of identifiers for which AWS DMS provides notification events.
notes

If you don't specify a value, notifications are provided for all sources.

If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.

sourceTypeoptionalstringsource_typeoptionalstrsourceTypeoptionalStringSourceTypeoptionalstringSourceTypeoptional*string#
The type of AWS DMS resource that generates the events.
notes

For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance . If this value isn't specified, all events are returned.

Valid values : replication-instance | replication-task

subscriptionNameoptionalstringsubscription_nameoptionalstrsubscriptionNameoptionalStringSubscriptionNameoptionalstringSubscriptionNameoptional*string#
The name of the AWS DMS event notification subscription.

This name must be less than 255 characters.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
One or more tags to be assigned to the event subscription.