Class CfnTopicRulePropsMixin.FirehoseActionProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.iot.CfnTopicRulePropsMixin.FirehoseActionProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTopicRulePropsMixin.FirehoseActionProperty>
- Enclosing interface:
CfnTopicRulePropsMixin.FirehoseActionProperty
@Stability(Stable)
public static final class CfnTopicRulePropsMixin.FirehoseActionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTopicRulePropsMixin.FirehoseActionProperty>
A builder for
CfnTopicRulePropsMixin.FirehoseActionProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getBatchMode()batchMode(IResolvable batchMode) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getBatchMode()build()Builds the configured instance.deliveryStreamName(String deliveryStreamName) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getDeliveryStreamName()deliveryStreamName(IDeliveryStreamRef deliveryStreamName) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getDeliveryStreamName()Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getRoleArn()Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getRoleArn()Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getSeparator()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
batchMode
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder batchMode(Boolean batchMode) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getBatchMode()- Parameters:
batchMode- Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch. The default value isfalse. WhenbatchModeistrueand the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatchrequest. The resulting array can't have more than 500 records.- Returns:
this
-
batchMode
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder batchMode(IResolvable batchMode) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getBatchMode()- Parameters:
batchMode- Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch. The default value isfalse. WhenbatchModeistrueand the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatchrequest. The resulting array can't have more than 500 records.- Returns:
this
-
deliveryStreamName
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder deliveryStreamName(String deliveryStreamName) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getDeliveryStreamName()- Parameters:
deliveryStreamName- The delivery stream name.- Returns:
this
-
deliveryStreamName
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder deliveryStreamName(IDeliveryStreamRef deliveryStreamName) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getDeliveryStreamName()- Parameters:
deliveryStreamName- The delivery stream name.- Returns:
this
-
roleArn
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder roleArn(String roleArn) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getRoleArn()- Parameters:
roleArn- The IAM role that grants access to the Amazon Kinesis Firehose stream.- Returns:
this
-
roleArn
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder roleArn(IRoleRef roleArn) Sets the value ofCfnTopicRulePropsMixin.FirehoseActionProperty.getRoleArn()- Parameters:
roleArn- The IAM role that grants access to the Amazon Kinesis Firehose stream.- Returns:
this
-
separator
@Stability(Stable) public CfnTopicRulePropsMixin.FirehoseActionProperty.Builder separator(String separator) Sets the value ofCfnTopicRulePropsMixin.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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnTopicRulePropsMixin.FirehoseActionProperty>- Returns:
- a new instance of
CfnTopicRulePropsMixin.FirehoseActionProperty - Throws:
NullPointerException- if any required attribute was not provided
-