KinesisStreamProps

class aws_cdk.aws_events_targets.KinesisStreamProps(*, message=None, partition_key_path=None)

Bases: object

Customize the Kinesis Stream Event Target.

Parameters
  • message (Optional[RuleTargetInput]) – The message to send to the stream. Must be a valid JSON text passed to the target stream. Default: - the entire CloudWatch event

  • partition_key_path (Optional[str]) – Partition Key Path for records sent to this stream. Default: - eventId as the partition key

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events as events
import aws_cdk.aws_events_targets as events_targets

# rule_target_input: events.RuleTargetInput

kinesis_stream_props = events_targets.KinesisStreamProps(
    message=rule_target_input,
    partition_key_path="partitionKeyPath"
)

Attributes

message

The message to send to the stream.

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

Default
  • the entire CloudWatch event

Return type

Optional[RuleTargetInput]

partition_key_path

Partition Key Path for records sent to this stream.

Default
  • eventId as the partition key

Return type

Optional[str]