CfnEventSubscriptionProps

class aws_cdk.aws_dms.CfnEventSubscriptionProps(*, sns_topic_arn, enabled=None, event_categories=None, source_ids=None, source_type=None, subscription_name=None, tags=None)

Bases: object

Properties for defining a CfnEventSubscription.

Parameters
  • sns_topic_arn (str) – 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.

  • enabled (Union[bool, IResolvable, None]) – Indicates whether to activate the subscription. If you don’t specify this property, AWS CloudFormation activates the subscription.

  • event_categories (Optional[Sequence[str]]) – A list of event categories for a source type that you want to subscribe to. 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 .

  • source_ids (Optional[Sequence[str]]) – A list of identifiers for which AWS DMS provides notification events. 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.

  • source_type (Optional[str]) – The type of AWS DMS resource that generates the events. 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

  • subscription_name (Optional[str]) – The name of the AWS DMS event notification subscription. This name must be less than 255 characters.

  • tags (Optional[Sequence[CfnTag]]) – One or more tags to be assigned to the event subscription.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_dms as dms

cfn_event_subscription_props = dms.CfnEventSubscriptionProps(
    sns_topic_arn="snsTopicArn",

    # the properties below are optional
    enabled=False,
    event_categories=["eventCategories"],
    source_ids=["sourceIds"],
    source_type="sourceType",
    subscription_name="subscriptionName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

enabled

Indicates whether to activate the subscription.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled

Return type

Union[bool, IResolvable, None]

event_categories

A list of event categories for a source type that you want to subscribe to.

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-eventcategories

Return type

Optional[List[str]]

sns_topic_arn

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-snstopicarn

Return type

str

source_ids

A list of identifiers for which AWS DMS provides notification events.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourceids

Return type

Optional[List[str]]

source_type

The type of AWS DMS resource that generates the events.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype

Return type

Optional[str]

subscription_name

The name of the AWS DMS event notification subscription.

This name must be less than 255 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname

Return type

Optional[str]

tags

One or more tags to be assigned to the event subscription.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags

Return type

Optional[List[CfnTag]]