CfnEventSubscriptionProps

class aws_cdk.aws_docdb.CfnEventSubscriptionProps(*, sns_topic_arn, enabled=None, event_categories=None, source_ids=None, source_type=None, subscription_name=None)

Bases: object

Properties for defining a CfnEventSubscription.

Parameters:

  • sns_topic_arn (str) – 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.

  • enabled (Union[bool, IResolvable, None]) – A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

  • event_categories (Optional[Sequence[str]]) – A list of event categories for a SourceType that you want to subscribe to.

  • source_ids (Optional[Sequence[str]]) – 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.

  • source_type (Optional[str]) – 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

  • subscription_name (Optional[str]) – The name of the subscription. Constraints: The name must be fewer than 255 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_docdb as docdb

cfn_event_subscription_props = docdb.CfnEventSubscriptionProps(
    sns_topic_arn="snsTopicArn",

    # the properties below are optional
    enabled=False,
    event_categories=["eventCategories"],
    source_ids=["sourceIds"],
    source_type="sourceType",
    subscription_name="subscriptionName"
)

Attributes

enabled

A Boolean value;

set to true to activate the subscription, set to false to create the subscription but not active it.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-enabled

event_categories

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-eventcategories

sns_topic_arn

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-snstopicarn

source_ids

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-sourceids

source_type

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-sourcetype

subscription_name

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-subscriptionname