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(Stable)
public static final class CfnTopicRule.FirehoseActionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTopicRule.FirehoseActionProperty>
A builder for
CfnTopicRule.FirehoseActionProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnTopicRule.FirehoseActionProperty.getBatchMode()
batchMode
(IResolvable batchMode) Sets the value ofCfnTopicRule.FirehoseActionProperty.getBatchMode()
build()
Builds the configured instance.deliveryStreamName
(String deliveryStreamName) Sets the value ofCfnTopicRule.FirehoseActionProperty.getDeliveryStreamName()
Sets the value ofCfnTopicRule.FirehoseActionProperty.getRoleArn()
Sets the value ofCfnTopicRule.FirehoseActionProperty.getSeparator()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
deliveryStreamName
@Stability(Stable) public CfnTopicRule.FirehoseActionProperty.Builder deliveryStreamName(String deliveryStreamName) Sets the value ofCfnTopicRule.FirehoseActionProperty.getDeliveryStreamName()
- Parameters:
deliveryStreamName
- The delivery stream name. This parameter is required.- Returns:
this
-
roleArn
Sets the value ofCfnTopicRule.FirehoseActionProperty.getRoleArn()
- Parameters:
roleArn
- The IAM role that grants access to the Amazon Kinesis Firehose stream. This parameter is required.- Returns:
this
-
batchMode
Sets the value ofCfnTopicRule.FirehoseActionProperty.getBatchMode()
- Parameters:
batchMode
- Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch
. The default value isfalse
. WhenbatchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- Returns:
this
-
batchMode
@Stability(Stable) public CfnTopicRule.FirehoseActionProperty.Builder batchMode(IResolvable batchMode) Sets the value ofCfnTopicRule.FirehoseActionProperty.getBatchMode()
- Parameters:
batchMode
- Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch
. The default value isfalse
. WhenbatchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- Returns:
this
-
separator
Sets the value ofCfnTopicRule.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:
build
in interfacesoftware.amazon.jsii.Builder<CfnTopicRule.FirehoseActionProperty>
- Returns:
- a new instance of
CfnTopicRule.FirehoseActionProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-