Skip to content

Modifies an existing Amazon DocumentDB event notification subscription

Description

Modifies an existing Amazon DocumentDB event notification subscription.

Usage

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

Arguments

  • SubscriptionName

    [required] The name of the Amazon DocumentDB 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 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

  • EventCategories

    A list of event categories for a SourceType that you want to subscribe to.

  • Enabled

    A Boolean value; set to true 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
)