Skip to content

Modifies an existing RDS event notification subscription

Description

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the add_source_identifier_to_subscription and remove_source_identifier_from_subscription calls.

You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the describe_event_categories operation.

Usage

rds_modify_event_subscription(SubscriptionName, SnsTopicArn, SourceType,
  EventCategories, Enabled)

Arguments

  • SubscriptionName

    [required] The name of the RDS event notification subscription.

  • SnsTopicArn

    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.

  • SourceType

    The type of source that is 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. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

    Valid Values:db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment

  • EventCategories

    A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the describe_event_categories operation.

  • Enabled

    Specifies whether to activate the subscription.

Value

A list with the following syntax:

list(
  EventSubscription = list(
    CustomerAwsId = "string",
    CustSubscriptionId = "string",
    SnsTopicArn = "string",
    Status = "string",
    SubscriptionCreationTime = "string",
    SourceType = "string",
    SourceIdsList = list(
      "string"
    ),
    EventCategoriesList = list(
      "string"
    ),
    Enabled = TRUE|FALSE,
    EventSubscriptionArn = "string"
  )
)

Request syntax

svc$modify_event_subscription(
  SubscriptionName = "string",
  SnsTopicArn = "string",
  SourceType = "string",
  EventCategories = list(
    "string"
  ),
  Enabled = TRUE|FALSE
)

Examples

# This example changes the specified setting for the specified event
# notification subscription.
svc$modify_event_subscription(
  Enabled = TRUE,
  EventCategories = list(
    "deletion",
    "low storage"
  ),
  SourceType = "db-instance",
  SubscriptionName = "mymysqleventsubscription"
)