Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.FirehoseActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.FirehoseActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.cfnpropertymixins.services.iot.*;
 FirehoseActionProperty firehoseActionProperty = FirehoseActionProperty.builder()
         .batchMode(false)
         .deliveryStreamName("deliveryStreamName")
         .roleArn("roleArn")
         .separator("separator")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRulePropsMixin.FirehoseActionProperty.Builder	builder()
default Object	getBatchMode()	Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch .
default Object	getDeliveryStreamName()	The delivery stream name.
default Object	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 Details

getBatchMode

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

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . 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 union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-batchmode

getDeliveryStreamName

@Stability(Stable)
@Nullable
default Object getDeliveryStreamName()

The delivery stream name.

Returns union: either String or IDeliveryStreamRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-deliverystreamname

getRoleArn

@Stability(Stable)
@Nullable
default Object getRoleArn()

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

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-rolearn

getSeparator

@Stability(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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-separator

builder

@Stability(Stable)
static CfnTopicRulePropsMixin.FirehoseActionProperty.Builder builder()

Returns:

a CfnTopicRulePropsMixin.FirehoseActionProperty.Builder of CfnTopicRulePropsMixin.FirehoseActionProperty