software.amazon.awscdk.services.iot.actions

Interface FirehoseStreamActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FirehoseStreamActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:10.357Z")
 @Stability(value=Experimental)
public interface FirehoseStreamActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an action for the Kinesis Data Firehose stream.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 Bucket bucket = new Bucket(this, "MyBucket");
 DeliveryStream stream = DeliveryStream.Builder.create(this, "MyStream")
         .destinations(List.of(new S3Bucket(bucket)))
         .build();
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
         .actions(List.of(
             FirehoseStreamAction.Builder.create(stream)
                     .batchMode(true)
                     .recordSeparator(FirehoseStreamRecordSeparator.NEWLINE)
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FirehoseStreamActionProps.Builder	builder()
default Boolean	getBatchMode() (experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.
default FirehoseStreamRecordSeparator	getRecordSeparator() (experimental) A character separator that will be used to separate records written to the Kinesis Data Firehose stream.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBatchMode

@Stability(value=Experimental)
 @Nullable
default Boolean getBatchMode()

(experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.

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.

Default: false

getRecordSeparator

@Stability(value=Experimental)
 @Nullable
default FirehoseStreamRecordSeparator getRecordSeparator()

(experimental) A character separator that will be used to separate records written to the Kinesis Data Firehose stream.

Default: - none -- the stream does not use a separator

builder

@Stability(value=Experimental)
static FirehoseStreamActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Returns:

a FirehoseStreamActionProps.Builder of FirehoseStreamActionProps