Skip to content

EventSubscription

Source code in docs_src/capo_docdb/types/event_subscription.py
class EventSubscription(TypedDict, closed=True):
    customer_aws_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.</p>"""
    cust_subscription_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon DocumentDB event notification subscription ID.</p>"""
    sns_topic_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The topic ARN of the Amazon DocumentDB event notification subscription.</p>"""
    status: NotRequired["capo_docdb.types.string.String"]
    """<p>The status of the Amazon DocumentDB event notification subscription.</p> <p>Constraints:</p> <p>Can be one of the following: <code>creating</code>, <code>modifying</code>, <code>deleting</code>, <code>active</code>, <code>no-permission</code>, <code>topic-not-exist</code> </p> <p>The <code>no-permission</code> status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The <code>topic-not-exist</code> status indicates that the topic was deleted after the subscription was created.</p>"""
    subscription_creation_time: NotRequired["capo_docdb.types.string.String"]
    """<p>The time at which the Amazon DocumentDB event notification subscription was created.</p>"""
    source_type: NotRequired["capo_docdb.types.string.String"]
    """<p>The source type for the Amazon DocumentDB event notification subscription.</p>"""
    source_ids_list: NotRequired["capo_docdb.types.source_ids_list.SourceIdsList"]
    """<p>A list of source IDs for the Amazon DocumentDB event notification subscription.</p>"""
    event_categories_list: NotRequired[
        "capo_docdb.types.event_categories_list.EventCategoriesList"
    ]
    """<p>A list of event categories for the Amazon DocumentDB event notification subscription.</p>"""
    enabled: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>A Boolean value indicating whether the subscription is enabled. A value of <code>true</code> indicates that the subscription is enabled.</p>"""
    event_subscription_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the event subscription.</p>"""

cust_subscription_id instance-attribute

cust_subscription_id: NotRequired[String]

The Amazon DocumentDB event notification subscription ID.

customer_aws_id instance-attribute

customer_aws_id: NotRequired[String]

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

enabled instance-attribute

enabled: NotRequired[Boolean]

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

event_categories_list instance-attribute

event_categories_list: NotRequired[EventCategoriesList]

A list of event categories for the Amazon DocumentDB event notification subscription.

event_subscription_arn instance-attribute

event_subscription_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the event subscription.

sns_topic_arn instance-attribute

sns_topic_arn: NotRequired[String]

The topic ARN of the Amazon DocumentDB event notification subscription.

source_ids_list instance-attribute

source_ids_list: NotRequired[SourceIdsList]

A list of source IDs for the Amazon DocumentDB event notification subscription.

source_type instance-attribute

source_type: NotRequired[String]

The source type for the Amazon DocumentDB event notification subscription.

status instance-attribute

status: NotRequired[String]

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

subscription_creation_time instance-attribute

subscription_creation_time: NotRequired[String]

The time at which the Amazon DocumentDB event notification subscription was created.