Package software.amazon.awscdk.services.events.targets

Class KinesisStream.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.KinesisStream.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KinesisStream>

Enclosing class:

KinesisStream

@Stability(Stable)
public static final class KinesisStream.Builder
extends Object
implements software.amazon.jsii.Builder<KinesisStream>

A fluent builder for KinesisStream.

Method Summary

Modifier and Type	Method	Description
KinesisStream	build()
static KinesisStream.Builder	create(IStream stream)
KinesisStream.Builder	message(RuleTargetInput message)	The message to send to the stream.
KinesisStream.Builder	partitionKeyPath(String partitionKeyPath)	Partition Key Path for records sent to this stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static KinesisStream.Builder create(IStream stream)

Parameters:

stream - This parameter is required.

Returns:

a new instance of KinesisStream.Builder.

message

@Stability(Stable)
public KinesisStream.Builder message(RuleTargetInput message)

The message to send to the stream.

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

Default: - the entire CloudWatch event

Parameters:

message - The message to send to the stream. This parameter is required.

Returns:

this

partitionKeyPath

@Stability(Stable)
public KinesisStream.Builder partitionKeyPath(String partitionKeyPath)

Partition Key Path for records sent to this stream.

Default: - eventId as the partition key

Parameters:

partitionKeyPath - Partition Key Path for records sent to this stream. This parameter is required.

Returns:

this

build

@Stability(Stable)
public KinesisStream build()

Specified by:

build in interface software.amazon.jsii.Builder<KinesisStream>

Returns:

a newly built instance of KinesisStream.