aws-cdk-lib.aws_iotevents.CfnAlarmModel.FirehoseProperty

interface FirehoseProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTEvents.CfnAlarmModel.FirehoseProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotevents#CfnAlarmModel_FirehoseProperty
Javasoftware.amazon.awscdk.services.iotevents.CfnAlarmModel.FirehoseProperty
Pythonaws_cdk.aws_iotevents.CfnAlarmModel.FirehoseProperty
TypeScript aws-cdk-lib » 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 { aws_iotevents as iotevents } from 'aws-cdk-lib';
const firehoseProperty: iotevents.CfnAlarmModel.FirehoseProperty = {
  deliveryStreamName: 'deliveryStreamName',

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

Properties

NameTypeDescription
deliveryStreamNamestringThe name of the Kinesis Data Firehose delivery stream where the data is written.
payload?IResolvable | PayloadPropertyYou can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
separator?stringA 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).