Package software.amazon.awscdk.services.iotevents

Interface CfnAlarmModel.FirehoseProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmModel.FirehoseProperty.Jsii$Proxy

Enclosing class:

CfnAlarmModel

@Stability(Stable)
public static interface CfnAlarmModel.FirehoseProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iotevents.*;
 FirehoseProperty firehoseProperty = FirehoseProperty.builder()
         .deliveryStreamName("deliveryStreamName")
         // the properties below are optional
         .payload(PayloadProperty.builder()
                 .contentExpression("contentExpression")
                 .type("type")
                 .build())
         .separator("separator")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarmModel.FirehoseProperty.Builder	builder()
String	getDeliveryStreamName()	The name of the Kinesis Data Firehose delivery stream where the data is written.
default Object	getPayload()	You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
default String	getSeparator()	A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeliveryStreamName

@Stability(Stable)
@NotNull
String getDeliveryStreamName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-deliverystreamname

getPayload

@Stability(Stable)
@Nullable
default Object getPayload()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-payload

getSeparator

@Stability(Stable)
@Nullable
default String getSeparator()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-separator

builder

@Stability(Stable)
static CfnAlarmModel.FirehoseProperty.Builder builder()

Returns:

a CfnAlarmModel.FirehoseProperty.Builder of CfnAlarmModel.FirehoseProperty