aws docdb modify-event-subscription

Modifies an existing Amazon DocumentDB event notification subscription. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To modify an event notification subscription

The following modify-event-subscription example adds the notification event category to the specified subscription and disables it. When you specify --event-categories, you must also specify --source-type.

aws docdb modify-event-subscription --subscription-name docdb-cluster-events --source-type db-cluster --event-categories failure maintenance notification --no-enabled

Identify

--subscription-nameThe name of the Amazon DocumentDB event notification subscription.

--source-typeThe type of source that is generating the events.

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

--no-enabledA Boolean value; set to true to activate the subscription.

Its output

{
    "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "docdb-cluster-events",
        "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:docdb-events",
        "Status": "active",
        "SubscriptionCreationTime": "2026-10-29 13:06:47.837",
        "SourceType": "db-cluster",
        "EventCategoriesList": [
            "failure",
            "maintenance",
            "notification"
        ],
        "Enabled": false,
        "EventSubscriptionArn": "arn:aws:rds:us-west-2:123456789012:es:docdb-cluster-events"
    }
}

For more information, see Managing Amazon DocumentDB event notification subscriptions in the Amazon DocumentDB Developer Guide.

Options

5 in the AWS CLI reference

--enabledA Boolean value; set to true to activate the subscription.

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

--sns-topic-arnThe Amazon Resource Name (ARN) of the SNS topic created for event notification.

--source-typeThe type of source that is generating the events.

--subscription-nameThe name of the Amazon DocumentDB event notification subscription.