AWS::Events::Rule KinesisParameters - AWS CloudFormation

AWS::Events::Rule KinesisParameters

The KinesisParameters property type specifies settings that control shard assignment for a Kinesis data stream target.

KinesisParameters is a property of the Target property type.

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard that the event goes to. If you don't include this parameter, the default is to use the eventId as the partition key.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "PartitionKeyPath" : String }

YAML

PartitionKeyPath: String

Properties

PartitionKeyPath

The JSON path to be extracted from the event and used as the partition key. For more information, see Partition Key in the Amazon Kinesis Data Streams Developer Guide.

Required: Yes

Type: String

Maximum: 256

Update requires: No interruption