Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon CloudWatch Events Rule Target

The Target property type specifies a target, such as AWS Lambda (Lambda) functions or Kinesis streams, that CloudWatch Events invokes when a rule is triggered. The Targets property of the AWS::Events::Rule resource contains a list of one or more Target property types.

Syntax

JSON

Copy
{ "Arn" : String, "Id" : String, "Input" : String, "InputPath" : String, "RoleArn" : String }

YAML

Copy
Arn: String Id: String Input: String InputPath: String RoleArn: String

Properties

Note

For more information about each property, including constraints and valid values, see Amazon CloudWatch Events Rule Target in the Amazon CloudWatch Events API Reference.

Arn

The Amazon Resource Name (ARN) of the target.

Required: Yes

Type: String

Id

A unique, user-defined identifier for the target. Acceptable values include alphanumeric characters, periods (.), hypens (-), and underscores (_).

Required: Yes

Type: String

Input

A JSON-formatted text string that is passed to the target. This value overrides the matched event.

Required: No. If you don't specify both this property and the InputPath, CloudWatch Events passes the entire matched event to the target.

Type: String

InputPath

When you don't want to pass the entire matched event, the JSONPath that describes which part of the event to pass to the target.

Required: No. If you don't specify both this property and the Input, CloudWatch Events passes the entire matched event to the target.

Type: String

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants CloudWatch Events permission to make calls to target services, such as AWS Lambda or Kinesis streams.

Required: No

Type: String

On this page: