Skip to content

CreateEventSubscriptionMessage

Source code in docs_src/capo_database_migration_service/types/create_event_subscription_message.py
class CreateEventSubscriptionMessage(TypedDict, closed=True):
    subscription_name: "capo_database_migration_service.types.string.String"
    """<p>The name of the DMS event notification subscription. This name must be less than 255 characters.</p>"""
    sns_topic_arn: "capo_database_migration_service.types.string.String"
    """<p> 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. </p>"""
    source_type: NotRequired["capo_database_migration_service.types.string.String"]
    """<p> 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 <code>replication-instance</code>. If this value isn't specified, all events are returned. </p> <p>Valid values: <code>replication-instance</code> | <code>replication-task</code> </p>"""
    event_categories: NotRequired[
        "capo_database_migration_service.types.event_categories_list.EventCategoriesList"
    ]
    """<p>A list of event categories for a source type that you want to subscribe to. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    source_ids: NotRequired[
        "capo_database_migration_service.types.source_ids_list.SourceIdsList"
    ]
    """<p>A list of identifiers for which DMS provides notification events.</p> <p>If you don't specify a value, notifications are provided for all sources.</p> <p>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.</p>"""
    enabled: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p> A Boolean value; set to <code>true</code> to activate the subscription, or set to <code>false</code> to create the subscription but not activate it. </p>"""
    tags: NotRequired["capo_database_migration_service.types.tag_list.TagList"]
    """<p>One or more tags to be assigned to the event subscription.</p>"""

enabled instance-attribute

enabled: NotRequired[BooleanOptional]

A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

event_categories instance-attribute

event_categories: NotRequired[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.

sns_topic_arn instance-attribute

sns_topic_arn: 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.

source_ids instance-attribute

source_ids: NotRequired[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.

source_type instance-attribute

source_type: NotRequired[String]

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

subscription_name instance-attribute

subscription_name: String

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

tags instance-attribute

tags: NotRequired[TagList]

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