AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::DMS::EventSubscription

使用 AWS::DMS::EventSubscription 资源可通过 Amazon Simple Notification Service 获取 AWS Database Migration Service 事件的通知。有关更多信息,请参阅 AWS Database Migration Service 用户指南 中的使用 AWS DMS 事件通知

语法

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

JSON

Copy
{ "Type" : "AWS::DMS::EventSubscription", "Properties" : { "Enabled" : Boolean, "EventCategories" : [ String, ... ], "SnsTopicArn" : String, "SourceIds" : [ String, ... ], "SourceType" : String, "SubscriptionName" : [ String, ... ], "Tags" : [ Resource Tag, ... ] } }

YAML

Copy
Type: "AWS::DMS::EventSubscription" Properties: Enabled: Boolean EventCategories: - 字符串 SnsTopicArn: String SourceIds: - 字符串 SourceType: String SubscriptionName: - 字符串 Tags: - Resource Tag

属性

Enabled

指示是否激活订阅。如果不指定此属性,AWS CloudFormation 将激活订阅。

Required: No

Type: Boolean

更新要求无需中断

EventCategories

要针对给定资源类型订阅的事件类别列表。如果不指定此属性,则会通知您有关所有事件类别的信息。有关更多信息,请参阅 AWS Database Migration Service 用户指南 中的使用 AWS DMS 事件通知

Required: No

Type: List of String values

更新要求无需中断

SnsTopicArn

要向其发送事件通知的 Amazon SNS 主题的 Amazon 资源名称 (ARN)。

Required: Yes

Type: String

更新要求无需中断

SourceIds

AWS DMS 为其提供通知事件的标识符的列表。

如果不指定值,则对所有源提供通知。如果指定多个值,它们必须属于同一类型。例如,如果指定一个数据库实例 ID,则所有其他值也必须是数据库实例 ID。

Required: No

Type: List of String values

更新要求替换

SourceType

AWS DMS 为其提供通知事件的源的类型。例如,如果希望收到关于数据库实例生成的事件的通知,请将此参数设置为 replication-instance。如果不指定值,则为所有源类型提供通知。对于有效值,请参阅 AWS Database Migration Service API Reference 中的 CreateEventSubscription 操作的 SourceType 参数。

Required: Conditional。如果指定 SourceIdsEventCategories 属性,则必须指定此属性。

Type: String

更新要求无需中断

SubscriptionName

订阅名称。

如果您未指定值,我们将创建一个随机值。

Required: No

Type: List of String values

更新要求替换

Tags

要附加到 DMS 事件订阅的标签。

Required: No

类型资源标签 (键/值格式) 的列表

更新要求替换

返回值

当该资源的逻辑 ID 提供给 Ref内部函数时,Ref 将返回资源名称。 示例:

Copy
{ "Ref": "myEventSubscription" }

对于逻辑 ID 为 myEventSubscription 的资源,Ref 返回 AWS DMS 事件订阅名称,如 mystack-myEventSubscription-1DDYF1E3B3I

有关使用 Ref 功能的更多信息,请参阅参考

示例

以下代码段为现有复制实例 rep-instance-1 (在同一模板中的其他位置声明) 创建一个事件订阅。

JSON

Copy
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "myEventSubscription": { "Type": "AWS::DMS::EventSubscription", "Properties": { "EventCategories": [ "configuration change", "failure", "deletion" ], "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:example-topic", "SourceIds": [ "rep-instance-1" ], "SourceType": "replication-instance", "Enabled": false } } } }

YAML

Copy
AWSTemplateFormatVersion: 2010-09-09 Resources: myEventSubscription: Type: 'AWS::DMS::EventSubscription' Properties: EventCategories: - configuration change - failure - deletion SnsTopicArn: 'arn:aws:sns:us-west-2:123456789012:example-topic' SourceIds: - rep-instance-1 SourceType: replication-instance Enabled: false

本页内容: