Create Event Subscription
docdb_create_event_subscription | R 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.
You can specify the type of source (SourceType
) that you want to be
notified of. You can also provide a list of Amazon DocumentDB sources
(SourceIds
) that trigger the events, and you can provide a list of
event categories (EventCategories
) for events that you want to be
notified of. For example, you can specify SourceType = db-instance
,
SourceIds = mydbinstance1, mydbinstance2
and
EventCategories = Availability, Backup
.
If you specify both the SourceType
and SourceIds
(such as
SourceType = db-instance
and SourceIdentifier = myDBInstance1
), you
are notified of all the db-instance
events for the specified source.
If you specify a SourceType
but do not specify a SourceIdentifier
,
you receive notice of the events for that source type for all your
Amazon DocumentDB sources. If you do not specify either the SourceType
or the SourceIdentifier
, you are notified of events generated from all
Amazon DocumentDB sources belonging to your customer account.
Usage¶
docdb_create_event_subscription(SubscriptionName, SnsTopicArn,
SourceType, EventCategories, SourceIds, Enabled, Tags)
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 tofalse
to create the subscription but not active it.Tags
The tags to be assigned to the event 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"
)
)