software.amazon.awscdk.services.iot

Interface CfnTopicRule.FirehoseActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.FirehoseActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTopicRule.FirehoseActionProperty.Builder A builder for CfnTopicRule.FirehoseActionProperty
static class	CfnTopicRule.FirehoseActionProperty.Jsii$Proxy An implementation for CfnTopicRule.FirehoseActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.FirehoseActionProperty.Builder	builder()
default Object	getBatchMode() 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) .
String	getDeliveryStreamName() The delivery stream name.
String	getRoleArn() The IAM role that grants access to the Amazon Kinesis Firehose stream.
default String	getSeparator() 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 Detail

getDeliveryStreamName

@Stability(value=Stable)
 @NotNull
String getDeliveryStreamName()

The delivery stream name.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The IAM role that grants access to the Amazon Kinesis Firehose stream.

getBatchMode

@Stability(value=Stable)
 @Nullable
default Object getBatchMode()

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.

getSeparator

@Stability(value=Stable)
 @Nullable
default String 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).

builder

@Stability(value=Stable)
static CfnTopicRule.FirehoseActionProperty.Builder builder()

Returns:

a CfnTopicRule.FirehoseActionProperty.Builder of CfnTopicRule.FirehoseActionProperty