aws-cdk-lib.aws_iotevents.CfnAlarmModel.PayloadProperty

interface PayloadProperty

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

Properties

NameTypeDescription
contentExpressionstringThe content of the payload.
typestringThe value of the payload type can be either STRING or JSON .

contentExpression

Type: string

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.


type

Type: string

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