Package software.amazon.awscdk.services.iotevents

Interface CfnDetectorModel.PayloadProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDetectorModel.PayloadProperty.Jsii$Proxy

Enclosing class:

CfnDetectorModel

@Stability(Stable)
public static interface CfnDetectorModel.PayloadProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContentExpression

@Stability(Stable)
@NotNull
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.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

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

See Also:

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

builder

@Stability(Stable)
static CfnDetectorModel.PayloadProperty.Builder builder()

Returns:

a CfnDetectorModel.PayloadProperty.Builder of CfnDetectorModel.PayloadProperty