docdb_create_event_subscription: Creates an Amazon DocumentDB event notification subscription

View source: R/docdb_operations.R

docdb_create_event_subscriptionR Documentation

Creates an Amazon DocumentDB event notification subscription

Description

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

See https://www.paws-r-sdk.com/docs/docdb_create_event_subscription/ for full documentation.

Usage

docdb_create_event_subscription(
  SubscriptionName,
  SnsTopicArn,
  SourceType = NULL,
  EventCategories = NULL,
  SourceIds = NULL,
  Enabled = NULL,
  Tags = NULL
)

Arguments

SubscriptionName

[required] The name of the subscription.

Constraints: The name must be fewer than 255 characters.

SnsTopicArn

[required] The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN 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, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

EventCategories

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

SourceIds

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are provided, SourceType must also be provided.

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

Enabled

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

Tags

The tags to be assigned to the event subscription.


paws.database documentation built on June 22, 2024, 11:50 a.m.