DocDB / Client / create_event_subscription

create_event_subscription#

DocDB.Client.create_event_subscription(**kwargs)#

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source ( SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources ( SourceIds) that trigger the events, and you can provide a list of event categories ( EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

See also: AWS API Documentation

Request Syntax

response = client.create_event_subscription(
    SubscriptionName='string',
    SnsTopicArn='string',
    SourceType='string',
    EventCategories=[
        'string',
    ],
    SourceIds=[
        'string',
    ],
    Enabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • SubscriptionName (string) –

    [REQUIRED]

    The name of the subscription.

    Constraints: The name must be fewer than 255 characters.

  • SnsTopicArn (string) –

    [REQUIRED]

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

  • SourceType (string) –

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

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

  • EventCategories (list) –

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

    • (string) –

  • SourceIds (list) –

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are provided, SourceType must also be provided.

    • If the source type is an instance, a DBInstanceIdentifier must be provided.

    • If the source type is a security group, a DBSecurityGroupName must be provided.

    • If the source type is a parameter group, a DBParameterGroupName must be provided.

    • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

    • (string) –

  • Enabled (boolean) – A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

  • Tags (list) –

    The tags to be assigned to the event subscription.

    • (dict) –

      Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

      • Key (string) –

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

      • Value (string) –

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustomerAwsId': 'string',
        'CustSubscriptionId': 'string',
        'SnsTopicArn': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string',
        'SourceType': 'string',
        'SourceIdsList': [
            'string',
        ],
        'EventCategoriesList': [
            'string',
        ],
        'Enabled': True|False,
        'EventSubscriptionArn': 'string'
    }
}

Response Structure

  • (dict) –

    • EventSubscription (dict) –

      Detailed information about an event to which you have subscribed.

      • CustomerAwsId (string) –

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

      • CustSubscriptionId (string) –

        The Amazon DocumentDB event notification subscription ID.

      • SnsTopicArn (string) –

        The topic ARN of the Amazon DocumentDB event notification subscription.

      • Status (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.

      • SubscriptionCreationTime (string) –

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

      • SourceType (string) –

        The source type for the Amazon DocumentDB event notification subscription.

      • SourceIdsList (list) –

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

        • (string) –

      • EventCategoriesList (list) –

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

        • (string) –

      • Enabled (boolean) –

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

      • EventSubscriptionArn (string) –

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

Exceptions