Interface CfnAlarmModel.PayloadProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnAlarmModel.PayloadProperty extends
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 PayloadProperty payloadProperty = PayloadProperty.builder()
  • 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.

    • getType

      @Stability(Stable) @NotNull String getType()
      The value of the payload type can be either STRING or JSON .
    • builder

      @Stability(Stable) static CfnAlarmModel.PayloadProperty.Builder builder()
      a CfnAlarmModel.PayloadProperty.Builder of CfnAlarmModel.PayloadProperty