interface CfnEventSubscriptionProps

Language	Type name
.NET	`Amazon.CDK.AWS.RDS.CfnEventSubscriptionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnEventSubscriptionProps`
Java	`software.amazon.awscdk.services.rds.CfnEventSubscriptionProps`
Python	`aws_cdk.aws_rds.CfnEventSubscriptionProps`
TypeScript	`aws-cdk-lib` » `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 { aws_rds as rds } from 'aws-cdk-lib';
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

Name	Type	Description
snsTopicArn	`string`	The Amazon Resource Name (ARN) of the SNS topic created for event notification.
enabled?	`boolean \|` `IResolvable`	Specifies 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?	`string`	The type of source that is generating the events.
subscriptionName?	`string`	The 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.

SNS automatically creates the ARN when you create a topic and subscribe to it.

RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide .

enabled?

Type: boolean | IResolvable (optional, default: true)

Specifies 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 SourceIds are 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.
If the source type is an RDS Proxy, a DBProxyName 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, you set this parameter to db-instance . For RDS Proxy events, specify db-proxy . If this value isn't specified, all events are returned.

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.