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

Amazon CloudWatch Events ルールターゲット

Target プロパティタイプは、ルールがトリガーされたときに CloudWatch イベント が呼び出す AWS Lambda (Lambda) 関数や Kinesis ストリームなどのターゲットを指定します。

AWS::Events::Rule リソースの Targets プロパティには、1 つ以上の Target プロパティタイプのリストが含まれています。

構文

JSON

Copy
{ "Arn" : String, "EcsParameters" : EcsParameters, "Id" : String, "Input" : String, "InputPath" : String, "InputTransformer" : InputTransformer, "KinesisParameters" : KinesisParameters, "RoleArn" : String, "RunCommandParameters" : RunCommandParameters }

プロパティ

注記

各プロパティの制約や有効な値などの詳細については、 『Amazon CloudWatch Events API リファレンス』の「Amazon CloudWatch イベント ルールターゲット」。

Arn

ターゲットの Amazon リソースネーム (ARN)。

Required: Yes

Type: String

EcsParameters

使用する Amazon ECS タスク定義とタスクカウント (イベントターゲットが Amazon ECS タスクの場合)

必須: いいえ

タイプ: CloudWatch イベント Rule EcsParameters

Id

ターゲットのユーザー定義の一意の識別子。使用できる値は、英数字、ピリオド (.)、ハイフン (-)、アンダースコア (_) です。

Required: Yes

Type: String

Input

ターゲットに渡される JSON 形式の文字列。この値は一致するイベントを上書きします。

Required: No. このプロパティと InputPath プロパティのどちらも指定しない場合、CloudWatch イベント は一致するイベント全体をターゲットに渡します。

Type: String

InputPath

一致するイベント全体を渡す必要がない場合の、ターゲットに渡すイベントの部分を記述した JSONPath。

Required: No. このプロパティと Input プロパティのどちらも指定しない場合、CloudWatch イベント は一致するイベント全体をターゲットに渡します。

Type: String

InputTransformer

特定のイベントデータに基づき、ターゲットにカスタム入力を行う設定。イベントから 1 つ以上のキーと値のペアを抽出し、そのデータを使用して、カスタマイズされた入力をターゲットに送信できます。

必須: いいえ

タイプ: CloudWatch イベント Rule InputTransformer

KinesisParameters

シャード割り当てを制御する設定 (ターゲットが Kinesis ストリームの場合)。このパラメータを使用しない場合は、パーティションキーとして eventId が使用されます。

必須: いいえ

タイプ: CloudWatch イベント Rule KinesisParameters

RoleArn

ルールがトリガーされた際、このターゲットを使用するための AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。 1 つのルールで複数のターゲットがトリガーされた場合は、各ターゲットのために、さまざまな IAM ロールを使用できます。

注記

CloudWatch イベント は、所有するリソースに対して API コールを行うための適切な権限が必要です。 Kinesis ストリームの場合、CloudWatch イベント は IAM ロールに依存します。Lambda、Amazon SNS、および Amazon SQS リソースの場合、CloudWatch イベント はリソースベースのポリシーに依存します。詳細については、Amazon CloudWatch ユーザーガイドCloudWatch イベント におけるリソースベースポリシーの使用を参照してください。

Required: No

Type: String

RunCommandParameters

ルールによって、Amazon EC2 Systems Manager Run Command が呼び出されたときに使用されるパラメータ。

必須: いいえ

タイプ: CloudWatch イベント Rule RunCommandParameters

次の例では、AWS::Events::Rule リソースのターゲットを定義します。その他の例については、『Amazon CloudWatch Events API リファレンス』の「PutTargets」を参照してください。

KinesisParameters を含むターゲット

次のスニペットでは、Kinesis ストリームのターゲットが作成されます。

JSON

Copy
"MyEventsRule": { "Type": "AWS::Events::Rule", "Properties": { "Description": "Events Rule with KinesisParameters", "EventPattern": { "source": [ "aws.ec2" ] }, "RoleArn": { "Fn::GetAtt": [ "EventsInvokeKinesisTargetRole", "Arn" ] }, "ScheduleExpression": "rate(5 minutes)", "State": "ENABLED", "Targets": [ { "Arn": { "Fn::GetAtt": [ "MyFirstStream", "Arn" ] }, "Id": "Id123", "RoleArn": { "Fn::GetAtt": [ "EventsInvokeKinesisTargetRole", "Arn" ] }, "KinesisParameters": { "PartitionKeyPath": "$" } } ] } }

YAML

Copy
MyEventsRule: Type: 'AWS::Events::Rule' Properties: Description: Events Rule with KinesisParameters EventPattern: source: - aws.ec2 RoleArn: !GetAtt - EventsInvokeKinesisTargetRole - Arn ScheduleExpression: rate(5 minutes) State: ENABLED Targets: - Arn: !GetAtt - MyFirstStream - Arn Id: Id123 RoleArn: !GetAtt - EventsInvokeKinesisTargetRole - Arn KinesisParameters: PartitionKeyPath: $

EcsParameters を含むターゲット

次のスニペットでは、Amazon ECS タスクのターゲットが作成されます。

JSON

Copy
"MyEventsRule": { "Type": "AWS::Events::Rule", "Properties": { "Description": "Events Rule with EcsParameters", "EventPattern": { "source": [ "aws.ec2" ], "detail-type": [ "EC2 Instance State-change Notification" ], "detail": { "state": [ "stopping" ] } }, "ScheduleExpression": "rate(15 minutes)", "State": "DISABLED", "Targets": [ { "Arn": { "Fn::GetAtt": [ "MyCluster", "Arn" ] }, "RoleArn": { "Fn::GetAtt": [ "ECSTaskRole", "Arn" ] }, "Id": "Id345", "EcsParameters": { "TaskCount": 1, "TaskDefinitionArn": { "Ref": "MyECSTask" } } } ] } }

YAML

Copy
MyEventsRule: Type: 'AWS::Events::Rule' Properties: Description: Events Rule with EcsParameters EventPattern: source: - aws.ec2 detail-type: - EC2 Instance State-change Notification detail: state: - stopping ScheduleExpression: rate(15 minutes) State: DISABLED Targets: - Arn: !GetAtt - MyCluster - Arn RoleArn: !GetAtt - ECSTaskRole - Arn Id: Id345 EcsParameters: TaskCount: 1 TaskDefinitionArn: !Ref MyECSTask

このページの内容: