Interface CfnTopicRule.FirehoseActionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTopicRule.FirehoseActionProperty.Jsii$Proxy
- Enclosing class:
CfnTopicRule
@Stability(Stable)
public static interface CfnTopicRule.FirehoseActionProperty
extends software.amazon.jsii.JsiiSerializable
Describes an action that writes data to an Amazon Kinesis Firehose stream.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; FirehoseActionProperty firehoseActionProperty = FirehoseActionProperty.builder() .deliveryStreamName("deliveryStreamName") .roleArn("roleArn") // the properties below are optional .batchMode(false) .separator("separator") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTopicRule.FirehoseActionProperty
static final class
An implementation forCfnTopicRule.FirehoseActionProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch
.The delivery stream name.The IAM role that grants access to the Amazon Kinesis Firehose stream.default String
A character separator that will be used to separate records written to the Firehose stream.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDeliveryStreamName
The delivery stream name.- See Also:
-
getRoleArn
The IAM role that grants access to the Amazon Kinesis Firehose stream.- See Also:
-
getBatchMode
Whether to deliver the Kinesis Data Firehose stream as a batch by usingPutRecordBatch
. The default value isfalse
.When
batchMode
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.- See Also:
-
getSeparator
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).
- See Also:
-
builder
-