AWS::Events::Rule KinesisParameters - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Events::Rule KinesisParameters

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 to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

Syntax

To declare this entity in your Amazon 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 Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Required: Yes

Type: String

Maximum: 256

Update requires: No interruption