AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DMS::EventSubscription

CfnEventSubscription

Use the `AWS::DMS::EventSubscription` resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service . For more information, see [Working with events and notifications in AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide* .

Import

import { CfnEventSubscription } from 'aws-cdk-lib/aws-dms';

Or use the module namespace:

import * as dms from 'aws-cdk-lib/aws-dms';
// dms.CfnEventSubscription

Properties

Configuration passed to the constructor as CfnEventSubscriptionProps.

snsTopicArnRequired
string

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.

enabledOptional
boolean | IResolvable

Indicates whether to activate the subscription. If you don't specify this property, CloudFormation activates the subscription.

eventCategoriesOptional
string[]

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](https://docs.aws.amazon.com//dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide* .

sourceIdsOptional
string[]

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.

sourceTypeOptional
string

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`

subscriptionNameOptional
string

The name of the AWS DMS event notification subscription. This name must be less than 255 characters.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::DMS::EventSubscriptionView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-dms
CFN TypeAWS::DMS::EventSubscription
Properties7

Related Constructs

Explore This Service

External Links