AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . docdb ]

add-source-identifier-to-subscription

Description

Adds a source identifier to an existing event notification subscription.

See also: AWS API Documentation

Synopsis

  add-source-identifier-to-subscription
--subscription-name <value>
--source-identifier <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--subscription-name (string)

The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

--source-identifier (string)

The identifier of the event source to be added:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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. 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.