Package software.amazon.awscdk.services.iotevents

Class CfnAlarmModel.AlarmActionProperty.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.iotevents.CfnAlarmModel.AlarmActionProperty.Jsii$Proxy
All Implemented Interfaces:
CfnAlarmModel.AlarmActionProperty, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnAlarmModel.AlarmActionProperty
@Stability(Stable) @Internal public static final class CfnAlarmModel.AlarmActionProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnAlarmModel.AlarmActionProperty
An implementation for CfnAlarmModel.AlarmActionProperty

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotevents.CfnAlarmModel.AlarmActionProperty

    CfnAlarmModel.AlarmActionProperty.Builder, CfnAlarmModel.AlarmActionProperty.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnAlarmModel.AlarmActionProperty.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnAlarmModel.AlarmActionProperty.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Object
    getDynamoDb()
    Defines an action to write to the Amazon DynamoDB table that you created.
    final Object
    getDynamoDBv2()
    Defines an action to write to the Amazon DynamoDB table that you created.
    final Object
    getFirehose()
    Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
    final Object
    getIotEvents()
    Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
    final Object
    getIotSiteWise()
    Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
    final Object
    getIotTopicPublish()
    Information required to publish the MQTT message through the AWS IoT message broker.
    final Object
    getLambda()
    Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
    final Object
    getSns()
    Information required to publish the Amazon SNS message.
    final Object
    getSqs()
    Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnAlarmModel.AlarmActionProperty.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnAlarmModel.AlarmActionProperty.Builder.

  • Method Details

    • getDynamoDb

      public final Object getDynamoDb()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Defines an action to write to the Amazon DynamoDB table that you created.

      The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

      You must use expressions for all parameters in DynamoDBAction . The expressions accept literals, operators, functions, references, and substitution templates.

      Examples - For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING' .

      • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name .
      • For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

      In the following example, the value for the hashKeyValue parameter uses a substitution template.

      '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

      • For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

      In the following example, the value for the tableName parameter uses a string concatenation.

      'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

      For more information, see Expressions in the AWS IoT Events Developer Guide .

      If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw .

      Specified by:
      getDynamoDb in interface CfnAlarmModel.AlarmActionProperty

    • getDynamoDBv2

      public final Object getDynamoDBv2()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Defines an action to write to the Amazon DynamoDB table that you created.

      The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

      You must use expressions for all parameters in DynamoDBv2Action . The expressions accept literals, operators, functions, references, and substitution templates.

      Examples - For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable' .

      • For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName .
      • For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

      In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

      '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

      • For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

      In the following example, the value for the tableName parameter uses a string concatenation.

      'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

      For more information, see Expressions in the AWS IoT Events Developer Guide .

      The value for the type parameter in Payload must be JSON .

      Specified by:
      getDynamoDBv2 in interface CfnAlarmModel.AlarmActionProperty

    • getFirehose

      public final Object getFirehose()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
      Specified by:
      getFirehose in interface CfnAlarmModel.AlarmActionProperty

    • getIotEvents

      public final Object getIotEvents()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
      Specified by:
      getIotEvents in interface CfnAlarmModel.AlarmActionProperty

    • getIotSiteWise

      public final Object getIotSiteWise()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .

      You must use expressions for all parameters in IotSiteWiseAction . The expressions accept literals, operators, functions, references, and substitutions templates.

      Examples - For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature' .

      • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1 .
      • For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

      In the following example, the value for the propertyAlias parameter uses a substitution template.

      'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

      You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise .

      For more information, see Expressions in the AWS IoT Events Developer Guide .

      Specified by:
      getIotSiteWise in interface CfnAlarmModel.AlarmActionProperty

    • getIotTopicPublish

      public final Object getIotTopicPublish()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Information required to publish the MQTT message through the AWS IoT message broker.
      Specified by:
      getIotTopicPublish in interface CfnAlarmModel.AlarmActionProperty

    • getLambda

      public final Object getLambda()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
      Specified by:
      getLambda in interface CfnAlarmModel.AlarmActionProperty

    • getSns

      public final Object getSns()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Information required to publish the Amazon SNS message.
      Specified by:
      getSns in interface CfnAlarmModel.AlarmActionProperty

    • getSqs

      public final Object getSqs()
      Description copied from interface: CfnAlarmModel.AlarmActionProperty
      Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
      Specified by:
      getSqs in interface CfnAlarmModel.AlarmActionProperty

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object