AWS::RDS::EventSubscription - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::RDS::EventSubscription

AWS::RDS::EventSubscription 资源允许您通过 Amazon Simple Notification Service (Amazon SNS) 接收 Amazon Relational Database Service 事件通知。有关更多信息,请参阅 Amazon RDS 用户指南 中的使用 Amazon RDS 事件通知

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

属性

Enabled

一个值,指示是否激活订阅。如果未激活事件通知订阅,将创建该订阅,但未处于活动状态。

必需:否

类型:布尔值

Update requires: No interruption

EventCategories

您要订阅到的 SourceType 的事件类别列表。您可以在 Amazon RDS 用户指南 中的事件主题内或者使用 DescribeEventCategories 操作来查看给定 SourceType 的类别列表。

必需:否

类型:字符串列表

Update requires: No interruption

SnsTopicArn

为事件通知创建的 SNS 主题的 Amazon 资源名称 (ARN)。在您创建主题并订阅到该主题时,由 Amazon SNS 创建 ARN。

必需:是

类型:字符串

Update requires: Replacement

SourceIds

为其返回事件的事件源的标识符列表。如果未指定,则响应中包含所有源。标识符必须以字母开头,且必须仅包含 ASCII 字母、数字和连字符。它不能以连字符结尾,也不能包含两个连续连字符。

约束:

  • 如果提供 SourceIds,则还必须提供 SourceType。

  • 如果源类型是数据库实例,则必须提供 DBInstanceIdentifier

  • 如果源类型是数据库安全组,则必须提供 DBSecurityGroupName

  • 如果源类型是数据库参数组,则必须提供 DBParameterGroupName

  • 如果源类型是数据库快照,则必须提供 DBSnapshotIdentifier

必需:否

类型:字符串列表

Update requires: No interruption

SourceType

生成事件的源的类型。例如,如果要接收数据库实例生成的事件的通知,应将该参数设置为 db-instance。如果未指定该值,则返回所有事件。

有效值:db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

必需:否

类型:字符串

Update requires: Some interruptions

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 RDS 事件订阅的名称。

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

示例

以下示例为现有数据库实例 db-instance-1 和逻辑 ID 为 myDBInstance 的数据库(在同一模板中的其他位置声明)创建一个事件订阅。

JSON

{ "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 } } }

YAML

--- 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"