interface KinesisParametersProperty

Language	Type name
.NET	Amazon.CDK.AWS.Events.CfnRule.KinesisParametersProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnRule_KinesisParametersProperty
Java	software.amazon.awscdk.services.events.CfnRule.KinesisParametersProperty
Python	aws_cdk.aws_events.CfnRule.KinesisParametersProperty
TypeScript	aws-cdk-lib » aws_events » CfnRule » KinesisParametersProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const kinesisParametersProperty: events.CfnRule.KinesisParametersProperty = {
  partitionKeyPath: 'partitionKeyPath',
};

Properties

Name	Type	Description
partitionKeyPath	string	The JSON path to be extracted from the event and used as the partition key.

---

partitionKeyPath

Type: string

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath