/AWS1/CL_DMG=>CREATEEVENTSUBSCRIPTION()
¶
About CreateEventSubscription¶
Creates an DMS event notification subscription.
You can specify the type of source (SourceType
) you want to be notified of,
provide a list of DMS source IDs (SourceIds
) that triggers the events, and
provide a list of event categories (EventCategories
) for events you want to be
notified of. If you specify both the SourceType
and SourceIds
,
such as SourceType = replication-instance
and SourceIdentifier =
my-replinstance
, you will be notified of all the replication instance events for
the specified source. If you specify a SourceType
but don't specify a
SourceIdentifier
, you receive notice of the events for that source type for
all your DMS sources. If you don't specify either SourceType
nor
SourceIdentifier
, you will be notified of events generated from all DMS
sources belonging to your customer account.
For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_SUBSCRIPTIONNAME
TYPE /AWS1/DMGSTRING
/AWS1/DMGSTRING
¶
The name of the DMS event notification subscription. This name must be less than 255 characters.
IV_SNSTOPICARN
TYPE /AWS1/DMGSTRING
/AWS1/DMGSTRING
¶
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.
Optional arguments:¶
IV_SOURCETYPE
TYPE /AWS1/DMGSTRING
/AWS1/DMGSTRING
¶
The type of 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
IT_EVENTCATEGORIES
TYPE /AWS1/CL_DMGEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST
TT_EVENTCATEGORIESLIST
¶
A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.
IT_SOURCEIDS
TYPE /AWS1/CL_DMGSOURCEIDSLIST_W=>TT_SOURCEIDSLIST
TT_SOURCEIDSLIST
¶
A list of identifiers for which 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.
IV_ENABLED
TYPE /AWS1/DMGBOOLEANOPTIONAL
/AWS1/DMGBOOLEANOPTIONAL
¶
A Boolean value; set to
true
to activate the subscription, or set tofalse
to create the subscription but not activate it.
IT_TAGS
TYPE /AWS1/CL_DMGTAG=>TT_TAGLIST
TT_TAGLIST
¶
One or more tags to be assigned to the event subscription.
RETURNING¶
OO_OUTPUT
TYPE REF TO /AWS1/CL_DMGCREEVTSUBSCRIPTI01
/AWS1/CL_DMGCREEVTSUBSCRIPTI01
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC