CreateEventSubscriptionMessage
¶
Source code in docs_src/capo_docdb/types/create_event_subscription_message.py
enabled
instance-attribute
¶
enabled: NotRequired[BooleanOptional]
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
event_categories
instance-attribute
¶
event_categories: NotRequired[EventCategoriesList]
A list of event categories for a SourceType that you want to subscribe to.
sns_topic_arn
instance-attribute
¶
sns_topic_arn: NotRequired[String]
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.
source_ids
instance-attribute
¶
source_ids: NotRequired[SourceIdsList]
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
SourceIdsare provided,SourceTypemust also be provided. -
If the source type is an instance, a
DBInstanceIdentifiermust be provided. -
If the source type is a security group, a
DBSecurityGroupNamemust be provided. -
If the source type is a parameter group, a
DBParameterGroupNamemust be provided. -
If the source type is a snapshot, a
DBSnapshotIdentifiermust be provided.
source_type
instance-attribute
¶
source_type: NotRequired[String]
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