Working with Events and Notifications in AWS Database Migration Service
AWS Database Migration Service (AWS DMS) uses Amazon Simple Notification Service (Amazon SNS) to provide notifications when an AWS DMS event occurs, for example the creation or deletion of a replication instance. You can work with these notifications in any form supported by Amazon SNS for an AWS Region, such as an email message, a text message, or a call to an HTTP endpoint.
AWS DMS groups events into categories that you can subscribe to, so you can be notified when an event in that category occurs. For example, if you subscribe to the Creation category for a given replication instance, you are notified whenever a creation-related event occurs that affects your replication instance. If you subscribe to a Configuration Change category for a replication instance, you are notified when the replication instance's configuration is changed. You also receive notification when an event notification subscription changes. For a list of the event categories provided by AWS DMS, see AWS DMS Event Categories and Event Messages, following.
AWS DMS sends event notifications to the addresses you provide when you create an
event
subscription. You might want to create several different subscriptions, such as one
subscription receiving all event notifications and another subscription that includes
only
critical events for your production DMS resources. You can easily turn off notification
without deleting a subscription by setting the Enabled option to
No in the AWS DMS console or by setting the
Enabled parameter to false using the
AWS DMS API.
Note
AWS DMS event notifications using SMS text messages are currently available for AWS DMS resources in all regions where AWS DMS is supported. For more information on using text messages with SNS, see Sending and Receiving SMS Notifications Using Amazon SNS.
AWS DMS uses a subscription identifier to identify each subscription. You can have multiple AWS DMS event subscriptions published to the same Amazon SNS topic. When you use event notification, Amazon SNS fees apply; for more information on Amazon SNS billing, see Amazon SNS Pricing.
To subscribe to AWS DMS events, you use the following process:
-
Create an Amazon SNS topic. In the topic, you specify what type of notification you want to receive and to what address or number the notification will go to.
-
Create an AWS DMS event notification subscription by using the AWS Management Console, AWS CLI, or AWS DMS API.
-
AWS DMS sends an approval email or SMS message to the addresses you submitted with your subscription. To confirm your subscription, click the link in the approval email or SMS message.
-
When you have confirmed the subscription, the status of your subscription is updated in the AWS DMS console's Event Subscriptions section.
-
You then begin to receive event notifications.
For the list of categories and events that you can be notified of, see the following section. For more details about subscribing to and working with AWS DMS event subscriptions, see Subscribing to AWS DMS Event Notification.
AWS DMS Event Categories and Event Messages
AWS DMS generates a significant number of events in categories that you can subscribe to using the AWS DMS console or the AWS DMS API. Each category applies to a source type; currently AWS DMS supports the replication instance and replication task source types.
The following table shows the possible categories and events for the replication instance source type.
The following table shows the possible categories and events for the replication task source type.
Subscribing to AWS DMS Event Notification
You can create an AWS DMS event notification subscription so you can be notified when an AWS DMS event occurs. The simplest way to create a subscription is with the AWS DMS console. If you choose to create event notification subscriptions using AWS DMS API, you must create an Amazon SNS topic and subscribe to that topic with the Amazon SNS console or API. In this case, you also need to note the topic's Amazon Resource Name (ARN), because this ARN is used when submitting CLI commands or API actions. For information on creating an Amazon SNS topic and subscribing to it, see Getting Started with Amazon SNS.
In a notification subscription, you can specify the type of source you want to be
notified of and the AWS DMS source that triggers the event. You define the AWS DMS
source type by using a SourceType value. You define the source
generating the event by using a SourceIdentifier value. If you
specify both SourceType and SourceIdentifier,
such as SourceType = db-instance and SourceIdentifier =
myDBInstance1, you receive all the DB_Instance events for the specified
source. If you specify SourceType but not
SourceIdentifier, you receive notice of the events for that
source type for all your AWS DMS sources. If you don't specify either
SourceType or SourceIdentifier, you are
notified of events generated from all AWS DMS sources belonging to your customer
account.
AWS Management Console
To subscribe to AWS DMS event notification by using the console
-
Sign in to the AWS Management Console and choose AWS DMS. Note that if you are signed in as an AWS Identity and Access Management (IAM) user, you must have the appropriate permissions to access AWS DMS.
-
In the navigation pane, choose Event Subscriptions.
-
On the Event Subscriptions page, choose Create Event Subscription.
-
On the Create Event Subscription page, do the following:
-
For Name, type a name for the event notification subscription.
-
Either choose an existing Amazon SNS topic for Send notifications to, or choose create topic. You must have either an existing Amazon SNS topic to send notices to or you must create the topic. If you choose create topic, you can enter an email address where notifications will be sent.
-
For Source Type, choose a source type. The only option is replication instance.
-
Choose Yes to enable the subscription. If you want to create the subscription but not have notifications sent yet, choose No.
-
Depending on the source type you selected, choose the event categories and sources you want to receive event notifications for.
-
Choose Create.
-
The AWS DMS console indicates that the subscription is being created.
AWS DMS API
To subscribe to AWS DMS event notification by using the AWS DMS API
-
Call
CreateEventSubscription.
