メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::RDS::EventSubscription

AWS::RDS::EventSubscription リソースを使用して、Amazon Simple Notification Service を通じて Amazon Relational Database Service イベントの通知を取得します。詳細については、Amazon Relational Database Service ユーザーガイドの「 Amazon RDS イベント通知の使用」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

Copy
Type: "AWS::RDS::EventSubscription" Properties: Enabled: Boolean EventCategories: - 文字列 SnsTopicArn: String SourceIds: - 文字列 SourceType: String

プロパティ

Enabled

サブスクリプションをアクティブ化するかどうかを示します。このプロパティを指定しないと、AWS CloudFormation はサブスクリプションをアクティブ化します。

Required: No

Type: Boolean

更新に伴う要件: 中断はありません。

EventCategories

特定のソースタイプについてサブスクライブするイベントカテゴリのリスト。このプロパティを指定しなかった場合、すべてのイベントカテゴリについて通知されます。詳細については、Amazon Relational Database Service ユーザーガイドの「 Amazon RDS イベント通知の使用」を参照してください。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

SnsTopicArn

イベント通知の送信先の Amazon SNS トピックの Amazon リソースネーム (ARN)。

Required: Yes

Type: String

更新に伴う要件: 置換

SourceIds

Amazon RDS が通知イベントを提供する ID のリスト。

値を指定しないと、すべてのソースについて通知が提供されます。複数の値を指定した場合、タイプが同じである必要があります。たとえば、データベースインスタンス ID を指定した場合は、他のすべての値もデータベースインスタンス ID である必要があります。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

SourceType

Amazon RDS で通知イベントを提供するソースのタイプ。たとえば、データベースインスタンスが生成したイベントの通知を受ける必要がある場合は、このパラメーターを db-instance に設定します。値を指定しないと、すべてのソースタイプの通知が提供されます。有効な値については、CreateEventSubscription アクションの SourceType パラメーター (Amazon Relational Database Service API Reference) を参照してください。

Required: Conditional。SourceIds または EventCategories プロパティを指定する場合は、このプロパティを指定する必要があります。

Type: String

更新に伴う要件: 置換 (このプロパティが以前に指定されていて、削除する場合) それ以外の更新に伴う中断はありません

戻り値

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。 例:

Copy
{ "Ref": "myEventSubscription" }

論理 ID myEventSubscription を持つリソースの場合、Ref は Amazon RDS イベントサブスクリプションの名前 (mystack-myEventSubscription-1DDYF1E3B3I など) を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次のスニペットは、既存のデータベースインスタンス db-instance-1 と、同じテンプレートの他の箇所で宣言された論理 ID myDBInstance を持つデータベースのイベントサブスクリプションを作成します。

JSON

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

Copy
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

このページの内容: