aws-cdk-lib.aws_iot.CfnTopicRule.FirehoseActionProperty

interface FirehoseActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.FirehoseActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_FirehoseActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.FirehoseActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.FirehoseActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » FirehoseActionProperty

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 { aws_iot as iot } from 'aws-cdk-lib';
const firehoseActionProperty: iot.CfnTopicRule.FirehoseActionProperty = {
  deliveryStreamName: 'deliveryStreamName',
  roleArn: 'roleArn',

  // the properties below are optional
  batchMode: false,
  separator: 'separator',
};

Properties

NameTypeDescription
deliveryStreamNamestringThe delivery stream name.
roleArnstringThe IAM role that grants access to the Amazon Kinesis Firehose stream.
batchMode?boolean | IResolvableWhether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .
separator?stringA character separator that will be used to separate records written to the Firehose stream.

deliveryStreamName

Type: string

The delivery stream name.


roleArn

Type: string

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


batchMode?

Type: boolean | IResolvable (optional)

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.


separator?

Type: string (optional)

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).