Skip to content

ModifyEventSubscriptionMessage

Source code in docs_src/capo_docdb/types/modify_event_subscription_message.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ModifyEventSubscriptionMessage(TypedDict, closed=True):
    subscription_name: NotRequired["capo_docdb.types.string.String"]
    """<p>The name of the Amazon DocumentDB event notification subscription.</p>"""
    sns_topic_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the 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_docdb.types.string.String"]
    """<p>The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to <code>db-instance</code>. If this value is not specified, all events are returned.</p> <p>Valid values: <code>db-instance</code>, <code>db-parameter-group</code>, <code>db-security-group</code> </p>"""
    event_categories: NotRequired[
        "capo_docdb.types.event_categories_list.EventCategoriesList"
    ]
    """<p> A list of event categories for a <code>SourceType</code> that you want to subscribe to.</p>"""
    enabled: NotRequired["capo_docdb.types.boolean_optional.BooleanOptional"]
    """<p> A Boolean value; set to <code>true</code> to activate the subscription. </p>"""

enabled instance-attribute 

enabled: NotRequired[BooleanOptional]

A Boolean value; set to true to activate the subscription.

event_categories instance-attribute 

event_categories: NotRequired[EventCategoriesList]

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

sns_topic_arn instance-attribute 

sns_topic_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

source_type instance-attribute 

source_type: NotRequired[String]

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

subscription_name instance-attribute 

subscription_name: NotRequired[String]

The name of the Amazon DocumentDB event notification subscription.