interface FirehoseProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTEvents.CfnAlarmModel.FirehoseProperty
Java	software.amazon.awscdk.services.iotevents.CfnAlarmModel.FirehoseProperty
Python	aws_cdk.aws_iotevents.CfnAlarmModel.FirehoseProperty
TypeScript	@aws-cdk/aws-iotevents » CfnAlarmModel » FirehoseProperty

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotevents from '@aws-cdk/aws-iotevents';
const firehoseProperty: iotevents.CfnAlarmModel.FirehoseProperty = {
  deliveryStreamName: 'deliveryStreamName',

  // the properties below are optional
  payload: {
    contentExpression: 'contentExpression',
    type: 'type',
  },
  separator: 'separator',
};

Properties

Name	Type	Description
deliveryStreamName	string	The name of the Kinesis Data Firehose delivery stream where the data is written.
payload?	IResolvable | PayloadProperty	You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
separator?	string	A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.

---

deliveryStreamName

Type: string

The name of the Kinesis Data Firehose delivery stream where the data is written.

---

payload?

Type: IResolvable | PayloadProperty (optional)

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

---

separator?

Type: string (optional)

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.

Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).