AWS::RDS::EventSubscriptionThe `AWS::RDS::EventSubscription` resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide* .
import { CfnEventSubscription } from 'aws-cdk-lib/aws-rds';Or use the module namespace:
import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnEventSubscriptionConfiguration passed to the constructor as CfnEventSubscriptionProps.
snsTopicArnRequiredstring | ITopicRefThe 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)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide* .
enabledOptionalboolean | IResolvableSpecifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
Default: - true
eventCategoriesOptionalstring[]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*](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [*Amazon Aurora User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html) . You can also see this list by using the `DescribeEventCategories` operation.
sourceIdsOptionalstring | IDBClusterRef | IDBInstanceRef[]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.
sourceTypeOptionalstringThe 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. Valid Values: `db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment`
subscriptionNameOptionalstringThe name of the subscription. Constraints: The name must be less than 255 characters.
tagsOptionalCfnTag[]An optional array of key-value pairs to apply to this subscription.
This L1 construct maps directly to the following CloudFormation resource type.
Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.
Download Free Infographicaws-rdsAWS::RDS::EventSubscription