Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-modify-event-subscription

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifier and RemoveSourceIdentifier calls.

You can see a list of the event categories and source types in the Events topic in the Amazon Relational Database Service User Guide or by using the DescribeEventCategories action.

Syntax

rds-modify-event-subscription subscription-name

-t (--sns-topic-arn) value

[--event-categories) value ]

[-s (--source-type) value ]

[--disable value ]

[General Options]

Options

Name Description Required

--subscription-name value

The name of the subscription to be modified.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-modify-event-subscription my-subscription-name.

Type: String

Constraints: The name must be less than 255 characters.

Example: --subscription-name mysubscription1

Yes

-t

--sns-topic-arn value

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

No

--event-categories value

-a value

A list of event categories for a source-type that you want to subscribe to.You can see a list of the categories for a given source-type in the Events topic in the Amazon Relational Database Service User Guide.

Type: String list

No

-s

--source-type value

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would 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 | db-snapshot

Type: String

No

--disable value

A Boolean value; set to false to activate the subscription. You can set this value to true if you want to create the subscription but not activate it. The default is true.

Type: Boolean

No

Output

The command returns a table with the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • CustSubscriptionId—the Id of the event subscription

  • CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification subscription

  • Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled

  • EventCategoriesList—a list of event categories for the RDS event notification subscription

  • SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription

  • SourceIdsList—a list of source Ids for the Amazon RDS event notification subscription

  • SourceType—the source type for the Amazon RDS event notification subscription

  • Status—the status of the Amazon RDS event notification subscription. 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 Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime—the time the Amazon RDS event notification subscription was created

Examples

Modifying an event subscription

This example modifies an existing subscription called MySubscription1 to include several event categories.

Copy
PROMPT> rds-modify-event-subscription MySubscription1 --EventCategories Creation, Deletion, Failure, Failover

Modifying an event subscription with multiple event categories

This example modifies a subscription called MySubscription2.

Copy
PROMPT> rds-modify-event-subscription MyProductionSubscription --SourceType MyDBInstance1, MyDBInstance2, MyDBSecGrp1, MyParmGrp --SourceType db-instance, db-parameter-group, db-security-group --EventCategories Failover, Failure, Configuration Change