aws-cdk-lib.aws_docdb.CfnEventSubscriptionProps

CfnEventSubscriptionProps Struct

Properties for defining a CfnEventSubscription.

CfnEventSubscriptionProps

used as props by

• CfnEventSubscription

Source

Generated code

Type last changed

v2.119.0 · 11 Jan 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnEventSubscriptionProps: docdb.CfnEventSubscriptionProps = {
  snsTopicArn: 'snsTopicArn',

  // the properties below are optional
  enabled: false,
  eventCategories: ['eventCategories'],
  sourceIds: ['sourceIds'],
  sourceType: 'sourceType',
  subscriptionName: 'subscriptionName',
};

Properties

enabled?optionalboolean | IResolvableenabled?optionaltyping.Union[bool, IResolvable]enabled?optionalBooleanEnabled?optionalboolEnabled?optionalinterface{}#

A Boolean value;

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

eventCategories?optionalstring[]event_categories?optionaltyping.List[str]eventCategories?optionalList<String>EventCategories?optionalstring[]EventCategories?optional*[]*string#

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

snsTopicArnstringsns_topic_arnstrsnsTopicArnStringSnsTopicArnstringSnsTopicArn*stringrequired#

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.

sourceIds?optionalstring[]source_ids?optionaltyping.List[str]sourceIds?optionalList<String>SourceIds?optionalstring[]SourceIds?optional*[]*string#

The list of identifiers of the event sources for which events are returned.

notes

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.

sourceType?optionalstringsource_type?optionalstrsourceType?optionalStringSourceType?optionalstringSourceType?optional*string#

The type of source that is generating the events.

notes

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

subscriptionName?optionalstringsubscription_name?optionalstrsubscriptionName?optionalStringSubscriptionName?optionalstringSubscriptionName?optional*string#

The name of the subscription.

Constraints: The name must be fewer than 255 characters.