aws-cdk-lib.aws_events_targets.KinesisStreamProps

interface KinesisStreamProps

LanguageType name
.NETAmazon.CDK.AWS.Events.Targets.KinesisStreamProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseventstargets#KinesisStreamProps
Javasoftware.amazon.awscdk.services.events.targets.KinesisStreamProps
Pythonaws_cdk.aws_events_targets.KinesisStreamProps
TypeScript (source)aws-cdk-lib » aws_events_targets » KinesisStreamProps

Customize the Kinesis Stream Event Target.

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';
import { aws_events_targets as events_targets } from 'aws-cdk-lib';

declare const ruleTargetInput: events.RuleTargetInput;
const kinesisStreamProps: events_targets.KinesisStreamProps = {
  message: ruleTargetInput,
  partitionKeyPath: 'partitionKeyPath',
};

Properties

NameTypeDescription
message?RuleTargetInputThe message to send to the stream.
partitionKeyPath?stringPartition Key Path for records sent to this stream.

message?

Type: RuleTargetInput (optional, default: the entire CloudWatch event)

The message to send to the stream.

Must be a valid JSON text passed to the target stream.


partitionKeyPath?

Type: string (optional, default: eventId as the partition key)

Partition Key Path for records sent to this stream.