software.amazon.awscdk.services.iotevents

Interface CfnAlarmModel.PayloadProperty

All Known Implementing Classes:

CfnAlarmModel.PayloadProperty.Jsii$Proxy

Enclosing class:

CfnAlarmModel

public static interface CfnAlarmModel.PayloadProperty

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

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.*;
 PayloadProperty payloadProperty = PayloadProperty.builder()
         .contentExpression("contentExpression")
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAlarmModel.PayloadProperty.Builder	builder()
java.lang.String	getContentExpression() The content of the payload.
java.lang.String	getType() The value of the payload type can be either `STRING` or `JSON` .

Method Detail

getContentExpression

java.lang.String getContentExpression()

The content of the payload.

You can use a string expression that includes quoted strings ( '<string>' ), variables ( $variable.<variable-name> ), input values ( $input.<input-name>.<path-to-datum> ), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

getType

java.lang.String getType()

The value of the payload type can be either `STRING` or `JSON` .

builder

static CfnAlarmModel.PayloadProperty.Builder builder()

Returns:

a CfnAlarmModel.PayloadProperty.Builder of CfnAlarmModel.PayloadProperty