AWS::RDS::EventSubscription - AWS CloudFormation


The 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 in the Amazon RDS User Guide.


To declare this entity in your AWS CloudFormation template, use the following syntax:


{ "Type" : "AWS::RDS::EventSubscription", "Properties" : { "Enabled" : Boolean, "EventCategories" : [ String, ... ], "SnsTopicArn" : String, "SourceIds" : [ String, ... ], "SourceType" : String } }


Type: AWS::RDS::EventSubscription Properties: Enabled: Boolean EventCategories: - String SnsTopicArn: String SourceIds: - String SourceType: String



A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Required: No

Type: Boolean

Update requires: No interruption


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 Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Required: No

Type: List of String

Update requires: No interruption


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.

Required: Yes

Type: String

Update requires: Replacement


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.


  • 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.

    Use a lowercase string when you specify the DBClusterIdentifier. Don't use a Ref because it will return the DBClusterIdentifier as an uppercase string.

  • 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.

Required: No

Type: List of String

Update requires: No interruption


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

Required: No

Type: String

Update requires: Some interruptions

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the RDS event subscription.

For more information about using the Ref function, see Ref.


The following example creates an event subscription for an existing database instance db-instance-1 and a database with the logical ID myDBInstance, which is declared elsewhere in the same template.


{ "myEventSubscription": { "Type": "AWS::RDS::EventSubscription", "Properties": { "EventCategories": [ "configuration change", "failure", "deletion" ], "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:example-topic", "SourceIds": [ "db-instance-1", { "Ref": "myDBInstance" } ], "SourceType": "db-instance", "Enabled": false } } }


--- myEventSubscription: Properties: Enabled: false EventCategories: - "configuration change" - failure - deletion SnsTopicArn: "arn:aws:sns:us-west-2:123456789012:example-topic" SourceIds: - db-instance-1 - Ref: myDBInstance SourceType: db-instance Type: "AWS::RDS::EventSubscription"