Show / Hide Table of Contents

Class CfnDetectorModelPropsMixin.PayloadProperty

Information needed to configure the payload.

Inheritance
object
CfnDetectorModelPropsMixin.PayloadProperty
Implements
CfnDetectorModelPropsMixin.IPayloadProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.IoTEvents.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnDetectorModelPropsMixin.PayloadProperty : CfnDetectorModelPropsMixin.IPayloadProperty
Syntax (vb)
Public Class CfnDetectorModelPropsMixin.PayloadProperty Implements CfnDetectorModelPropsMixin.IPayloadProperty
Remarks

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 .

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.IoTEvents.Mixins;

             var payloadProperty = new PayloadProperty {
                 ContentExpression = "contentExpression",
                 Type = "type"
             };

Synopsis

Constructors

PayloadProperty()

Information needed to configure the payload.

Properties

ContentExpression

The content of the payload.

Type

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

Constructors

PayloadProperty()

Information needed to configure the payload.

public PayloadProperty()
Remarks

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 .

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.IoTEvents.Mixins;

             var payloadProperty = new PayloadProperty {
                 ContentExpression = "contentExpression",
                 Type = "type"
             };

Properties

ContentExpression

The content of the payload.

public string? ContentExpression { get; set; }
Property Value

string

Remarks

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

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

Type

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

public string? Type { get; set; }
Property Value

string

Remarks

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

Implements

CfnDetectorModelPropsMixin.IPayloadProperty
Back to top Generated by DocFX