aws-cdk-lib.aws_pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty

interface PipeTargetKinesisStreamParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.Pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeTargetKinesisStreamParametersProperty
Javasoftware.amazon.awscdk.services.pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty
Pythonaws_cdk.aws_pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty
TypeScript aws-cdk-lib » aws_pipes » CfnPipe » PipeTargetKinesisStreamParametersProperty

The parameters for using a Kinesis stream as a target.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeTargetKinesisStreamParametersProperty: pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty = {
  partitionKey: 'partitionKey',
};

Properties

NameTypeDescription
partitionKeystringDetermines which shard in the stream the data record is assigned to.

partitionKey

Type: string

Determines which shard in the stream the data record is assigned to.

Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.