Package software.amazon.awscdk.services.iot.actions.alpha

Class KinesisPutRecordAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.alpha.KinesisPutRecordAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KinesisPutRecordAction>

Enclosing class:

KinesisPutRecordAction

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

(experimental) A fluent builder for KinesisPutRecordAction.

Method Summary

Modifier and Type	Method	Description
KinesisPutRecordAction	build()
static KinesisPutRecordAction.Builder	create(IStream stream)
KinesisPutRecordAction.Builder	partitionKey(String partitionKey)	(experimental) The partition key used to determine to which shard the data is written.
KinesisPutRecordAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static KinesisPutRecordAction.Builder create(IStream stream)

Parameters:

stream - The Kinesis Data stream to which to put records. This parameter is required.

Returns:

a new instance of KinesisPutRecordAction.Builder.

role

@Stability(Experimental)
public KinesisPutRecordAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

partitionKey

@Stability(Experimental)
public KinesisPutRecordAction.Builder partitionKey(String partitionKey)

(experimental) The partition key used to determine to which shard the data is written.

The partition key is usually composed of an expression (for example, ${topic()} or ${timestamp()}).

Parameters:

partitionKey - The partition key used to determine to which shard the data is written. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_RequestParameters

build

@Stability(Experimental)
public KinesisPutRecordAction build()

Specified by:

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

Returns:

a newly built instance of KinesisPutRecordAction.