Modifies an existing Amazon DocumentDB event notification subscription.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
modify-event-subscription
--subscription-name <value>
[--sns-topic-arn <value>]
[--source-type <value>]
[--event-categories <value>]
[--enabled | --no-enabled]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--subscription-name
(string)
The name of the Amazon DocumentDB event notification subscription.
--sns-topic-arn
(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
(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
--event-categories
(list)
A list of event categories for a
SourceType
that you want to subscribe to.(string)
Syntax:
"string" "string" ...
--enabled
| --no-enabled
(boolean)
A Boolean value; set to
true
to activate the subscription.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
EventSubscription -> (structure)
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. Thetopic-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.