software.amazon.awscdk.services.iot.actions

Class FirehoseStreamAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.FirehoseStreamAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FirehoseStreamAction>

Enclosing class:

FirehoseStreamAction

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

(experimental) A fluent builder for FirehoseStreamAction.

Method Summary

Modifier and Type	Method and Description
FirehoseStreamAction.Builder	batchMode(Boolean batchMode) (experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.
FirehoseStreamAction	build()
static FirehoseStreamAction.Builder	create(IDeliveryStream stream)
FirehoseStreamAction.Builder	recordSeparator(FirehoseStreamRecordSeparator recordSeparator) (experimental) A character separator that will be used to separate records written to the Kinesis Data Firehose stream.
FirehoseStreamAction.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 Detail

create

@Stability(value=Experimental)
public static FirehoseStreamAction.Builder create(IDeliveryStream stream)

Parameters:

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

Returns:

a new instance of FirehoseStreamAction.Builder.

role

@Stability(value=Experimental)
public FirehoseStreamAction.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

batchMode

@Stability(value=Experimental)
public FirehoseStreamAction.Builder batchMode(Boolean batchMode)

(experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch request. The resulting array can't have more than 500 records.

Default: false

Parameters:

batchMode - Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`. This parameter is required.

Returns:

this

recordSeparator

@Stability(value=Experimental)
public FirehoseStreamAction.Builder recordSeparator(FirehoseStreamRecordSeparator recordSeparator)

(experimental) A character separator that will be used to separate records written to the Kinesis Data Firehose stream.

Default: - none -- the stream does not use a separator

Parameters:

recordSeparator - A character separator that will be used to separate records written to the Kinesis Data Firehose stream. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public FirehoseStreamAction build()

Specified by:

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