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

remove-source-identifier-from-subscription

Description

Removes a source identifier from an existing RDS event notification subscription.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  remove-source-identifier-from-subscription
--subscription-name <value>
--source-identifier <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--subscription-name (string)

The name of the RDS event notification subscription you want to remove a source identifier from.

--source-identifier (string)

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

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

See 'aws help' for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To remove a source identifier from a subscription

The following remove-source-identifier example removes the specified source identifier from an existing subscription.

aws rds remove-source-identifier-from-subscription \
    --subscription-name my-instance-events \
    --source-identifier test-instance-repl

Output:

{
    "EventSubscription": {
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "Status": "modifying",
        "CustSubscriptionId": "my-instance-events",
        "CustomerAwsId": "123456789012",
        "SourceIdsList": [
            "test-instance"
        ],
        "SourceType": "db-instance",
        "Enabled": false
    }
}

Output

EventSubscription -> (structure)

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

CustomerAwsId -> (string)

The Amazon Web Services customer account associated with the RDS event notification subscription.

CustSubscriptionId -> (string)

The RDS event notification subscription Id.

SnsTopicArn -> (string)

The topic ARN of the RDS event notification subscription.

Status -> (string)

The status of the RDS event notification subscription.

Constraints:

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

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

SubscriptionCreationTime -> (string)

The time the RDS event notification subscription was created.

SourceType -> (string)

The source type for the RDS event notification subscription.

SourceIdsList -> (list)

A list of source IDs for the RDS event notification subscription.

(string)

EventCategoriesList -> (list)

A list of event categories for the RDS event notification subscription.

(string)

Enabled -> (boolean)

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

EventSubscriptionArn -> (string)

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