@aws-cdk_aws-iot-actions-alpha.FirehosePutRecordActionProps

interface FirehosePutRecordActionProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.IoT.Actions.Alpha.FirehosePutRecordActionProps
Gogithub.com/aws/aws-cdk-go/awscdkiotactionsalpha/v2#FirehosePutRecordActionProps
Javasoftware.amazon.awscdk.services.iot.actions.alpha.FirehosePutRecordActionProps
Pythonaws_cdk.aws_iot_actions_alpha.FirehosePutRecordActionProps
TypeScript (source)@aws-cdk/aws-iot-actions-alpha ยป FirehosePutRecordActionProps

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

Example

import * as firehose from '@aws-cdk/aws-kinesisfirehose-alpha';
import * as destinations from '@aws-cdk/aws-kinesisfirehose-destinations-alpha';

const bucket = new s3.Bucket(this, 'MyBucket');
const stream = new firehose.DeliveryStream(this, 'MyStream', {
  destinations: [new destinations.S3Bucket(bucket)],
});

const topicRule = new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"),
  actions: [
    new actions.FirehosePutRecordAction(stream, {
      batchMode: true,
      recordSeparator: actions.FirehoseRecordSeparator.NEWLINE,
    }),
  ],
});

Properties

NameTypeDescription
batchMode?๐Ÿ”นbooleanWhether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch.
recordSeparator?๐Ÿ”นFirehoseRecordSeparatorA character separator that will be used to separate records written to the Kinesis Data Firehose stream.
role?๐Ÿ”นIRoleThe IAM role that allows access to AWS service.

batchMode?๐Ÿ”น

Type: boolean (optional, default: false)

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.


recordSeparator?๐Ÿ”น

Type: FirehoseRecordSeparator (optional, default: none -- the stream does not use a separator)

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


role?๐Ÿ”น

Type: IRole (optional, default: a new role will be created)

The IAM role that allows access to AWS service.