Class CfnAlarmModel.AlarmActionProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnAlarmModel.AlarmActionProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnAlarmModel.AlarmActionProperty
CfnAlarmModel.AlarmActionProperty-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.iotevents.CfnAlarmModel.AlarmActionProperty
CfnAlarmModel.AlarmActionProperty.Builder, CfnAlarmModel.AlarmActionProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnAlarmModel.AlarmActionProperty.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal ObjectDefines an action to write to the Amazon DynamoDB table that you created.final ObjectDefines an action to write to the Amazon DynamoDB table that you created.final ObjectSends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.final ObjectSends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.final ObjectSends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .final ObjectInformation required to publish the MQTT message through the AWS IoT message broker.final ObjectCalls a Lambda function, passing in information about the detector model instance and the event that triggered the action.final ObjectgetSns()Information required to publish the Amazon SNS message.final ObjectgetSqs()Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theCfnAlarmModel.AlarmActionProperty.Builder.
-
-
Method Details
-
getDynamoDb
Description copied from interface:CfnAlarmModel.AlarmActionPropertyDefines 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
hashKeyTypeparameter can be'STRING'.- For references, you must specify either variables or input values. For example, the value for the
hashKeyFieldparameter 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
hashKeyValueparameter 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
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.dateFor more information, see Expressions in the AWS IoT Events Developer Guide .
If the defined payload type is a string,
DynamoDBActionwrites non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for thepayloadFieldparameter is<payload-field>_raw.Returns union: either
IResolvableorCfnAlarmModel.DynamoDBProperty- Specified by:
getDynamoDbin interfaceCfnAlarmModel.AlarmActionProperty- See Also:
- For references, you must specify either variables or input values. For example, the value for the
-
getDynamoDBv2
Description copied from interface:CfnAlarmModel.AlarmActionPropertyDefines 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
tableNameparameter can be'GreenhouseTemperatureTable'.- For references, you must specify either variables or input values. For example, the value for the
tableNameparameter 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
contentExpressionparameter inPayloaduses 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
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.dateFor more information, see Expressions in the AWS IoT Events Developer Guide .
The value for the
typeparameter inPayloadmust beJSON.Returns union: either
IResolvableorCfnAlarmModel.DynamoDBv2Property- Specified by:
getDynamoDBv2in interfaceCfnAlarmModel.AlarmActionProperty- See Also:
- For references, you must specify either variables or input values. For example, the value for the
-
getFirehose
Description copied from interface:CfnAlarmModel.AlarmActionPropertySends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.Returns union: either
IResolvableorCfnAlarmModel.FirehoseProperty- Specified by:
getFirehosein interfaceCfnAlarmModel.AlarmActionProperty- See Also:
-
getIotEvents
Description copied from interface:CfnAlarmModel.AlarmActionPropertySends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.Returns union: either
IResolvableorCfnAlarmModel.IotEventsProperty- Specified by:
getIotEventsin interfaceCfnAlarmModel.AlarmActionProperty- See Also:
-
getIotSiteWise
Description copied from interface:CfnAlarmModel.AlarmActionPropertySends 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
propertyAliasparameter can be'/company/windfarm/3/turbine/7/temperature'.- For references, you must specify either variables or input values. For example, the value for the
assetIdparameter 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
propertyAliasparameter uses a substitution template.'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'You must specify either
propertyAliasor bothassetIdandpropertyIdto identify the target asset property in AWS IoT SiteWise .For more information, see Expressions in the AWS IoT Events Developer Guide .
Returns union: either
IResolvableorCfnAlarmModel.IotSiteWiseProperty- Specified by:
getIotSiteWisein interfaceCfnAlarmModel.AlarmActionProperty- See Also:
- For references, you must specify either variables or input values. For example, the value for the
-
getIotTopicPublish
Description copied from interface:CfnAlarmModel.AlarmActionPropertyInformation required to publish the MQTT message through the AWS IoT message broker.Returns union: either
IResolvableorCfnAlarmModel.IotTopicPublishProperty- Specified by:
getIotTopicPublishin interfaceCfnAlarmModel.AlarmActionProperty- See Also:
-
getLambda
Description copied from interface:CfnAlarmModel.AlarmActionPropertyCalls a Lambda function, passing in information about the detector model instance and the event that triggered the action.Returns union: either
IResolvableorCfnAlarmModel.LambdaProperty- Specified by:
getLambdain interfaceCfnAlarmModel.AlarmActionProperty- See Also:
-
getSns
Description copied from interface:CfnAlarmModel.AlarmActionPropertyInformation required to publish the Amazon SNS message.Returns union: either
IResolvableorCfnAlarmModel.SnsProperty- Specified by:
getSnsin interfaceCfnAlarmModel.AlarmActionProperty- See Also:
-
getSqs
Description copied from interface:CfnAlarmModel.AlarmActionPropertySends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.Returns union: either
IResolvableorCfnAlarmModel.SqsProperty- Specified by:
getSqsin interfaceCfnAlarmModel.AlarmActionProperty- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-