software.amazon.awscdk.services.iot

Class CfnTopicRule.FirehoseActionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnTopicRule.FirehoseActionProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTopicRule.FirehoseActionProperty>

Enclosing interface:

CfnTopicRule.FirehoseActionProperty

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

A builder for CfnTopicRule.FirehoseActionProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnTopicRule.FirehoseActionProperty.Builder	batchMode(Boolean batchMode) Sets the value of CfnTopicRule.FirehoseActionProperty.getBatchMode()
CfnTopicRule.FirehoseActionProperty.Builder	batchMode(IResolvable batchMode) Sets the value of CfnTopicRule.FirehoseActionProperty.getBatchMode()
CfnTopicRule.FirehoseActionProperty	build() Builds the configured instance.
CfnTopicRule.FirehoseActionProperty.Builder	deliveryStreamName(String deliveryStreamName) Sets the value of CfnTopicRule.FirehoseActionProperty.getDeliveryStreamName()
CfnTopicRule.FirehoseActionProperty.Builder	roleArn(String roleArn) Sets the value of CfnTopicRule.FirehoseActionProperty.getRoleArn()
CfnTopicRule.FirehoseActionProperty.Builder	separator(String separator) Sets the value of CfnTopicRule.FirehoseActionProperty.getSeparator()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

deliveryStreamName

@Stability(value=Stable)
public CfnTopicRule.FirehoseActionProperty.Builder deliveryStreamName(String deliveryStreamName)

Sets the value of CfnTopicRule.FirehoseActionProperty.getDeliveryStreamName()

Parameters:

deliveryStreamName - The delivery stream name. This parameter is required.

Returns:

this

roleArn

@Stability(value=Stable)
public CfnTopicRule.FirehoseActionProperty.Builder roleArn(String roleArn)

Sets the value of CfnTopicRule.FirehoseActionProperty.getRoleArn()

Parameters:

roleArn - The IAM role that grants access to the Amazon Kinesis Firehose stream. This parameter is required.

Returns:

this

batchMode

@Stability(value=Stable)
public CfnTopicRule.FirehoseActionProperty.Builder batchMode(Boolean batchMode)

Sets the value of CfnTopicRule.FirehoseActionProperty.getBatchMode()

Parameters:

batchMode - Whether to deliver the Kinesis Data Firehose stream as a batch by using [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) . The default value is `false` . 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.

Returns:

this

batchMode

@Stability(value=Stable)
public CfnTopicRule.FirehoseActionProperty.Builder batchMode(IResolvable batchMode)

Sets the value of CfnTopicRule.FirehoseActionProperty.getBatchMode()

Parameters:

batchMode - Whether to deliver the Kinesis Data Firehose stream as a batch by using [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) . The default value is `false` . 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.

Returns:

this

separator

@Stability(value=Stable)
public CfnTopicRule.FirehoseActionProperty.Builder separator(String separator)

Sets the value of CfnTopicRule.FirehoseActionProperty.getSeparator()

Parameters:

separator - A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

Returns:

this

build

@Stability(value=Stable)
public CfnTopicRule.FirehoseActionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTopicRule.FirehoseActionProperty>

Returns:

a new instance of CfnTopicRule.FirehoseActionProperty

Throws:

NullPointerException - if any required attribute was not provided