1.204.0

interface CfnEventSubscriptionProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnEventSubscriptionProps
Javasoftware.amazon.awscdk.services.rds.CfnEventSubscriptionProps
Pythonaws_cdk.aws_rds.CfnEventSubscriptionProps
TypeScript @aws-cdk/aws-rds » CfnEventSubscriptionProps

Properties for defining a CfnEventSubscription.

Example

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

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

Properties

NameTypeDescription
snsTopicArnstringThe Amazon Resource Name (ARN) of the SNS topic created for event notification.
enabled?boolean | IResolvableA value that indicates whether to activate the subscription.
eventCategories?string[]A list of event categories for a particular source type ( SourceType ) that you want to subscribe to.
sourceIds?string[]The list of identifiers of the event sources for which events are returned.
sourceType?stringThe type of source that is generating the events.
subscriptionName?stringThe name of the subscription.
tags?CfnTag[]An optional array of key-value pairs to apply to this subscription.

snsTopicArn

Type: string

The Amazon Resource Name (ARN) of the SNS topic created for event notification.

The ARN is created by Amazon SNS when you create a topic and subscribe to it.

enabled?

Type: boolean | IResolvable (optional)

A value that indicates whether to activate the subscription.

If the event notification subscription isn't activated, the subscription is created but not active.

eventCategories?

Type: string[] (optional)

A list of event categories for a particular source type ( SourceType ) that you want to subscribe to.

You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

sourceIds?

Type: string[] (optional)

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 a SourceIds value is supplied, SourceType must also be provided.
  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

sourceType?

Type: string (optional)

The type of source that is generating the events.

For example, if you want to be notified of events generated by a DB instance, set this parameter to db-instance . If this value isn't specified, all events are returned.

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

subscriptionName?

Type: string (optional)

The name of the subscription.

Constraints: The name must be less than 255 characters.

tags?

Type: CfnTag[] (optional)

An optional array of key-value pairs to apply to this subscription.

← PreviousNext →