software.amazon.awscdk.services.iotevents

Interface CfnAlarmModel.AlarmActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmModel.AlarmActionProperty.Jsii$Proxy

Enclosing class:

CfnAlarmModel

@Stability(value=Stable)
public static interface CfnAlarmModel.AlarmActionProperty
extends software.amazon.jsii.JsiiSerializable

Specifies one of the following actions to receive notifications when the alarm state changes.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotevents.*;
 AlarmActionProperty alarmActionProperty = AlarmActionProperty.builder()
         .dynamoDb(DynamoDBProperty.builder()
                 .hashKeyField("hashKeyField")
                 .hashKeyValue("hashKeyValue")
                 .tableName("tableName")
                 // the properties below are optional
                 .hashKeyType("hashKeyType")
                 .operation("operation")
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .payloadField("payloadField")
                 .rangeKeyField("rangeKeyField")
                 .rangeKeyType("rangeKeyType")
                 .rangeKeyValue("rangeKeyValue")
                 .build())
         .dynamoDBv2(DynamoDBv2Property.builder()
                 .tableName("tableName")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .build())
         .firehose(FirehoseProperty.builder()
                 .deliveryStreamName("deliveryStreamName")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .separator("separator")
                 .build())
         .iotEvents(IotEventsProperty.builder()
                 .inputName("inputName")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .build())
         .iotSiteWise(IotSiteWiseProperty.builder()
                 .assetId("assetId")
                 .entryId("entryId")
                 .propertyAlias("propertyAlias")
                 .propertyId("propertyId")
                 .propertyValue(AssetPropertyValueProperty.builder()
                         .value(AssetPropertyVariantProperty.builder()
                                 .booleanValue("booleanValue")
                                 .doubleValue("doubleValue")
                                 .integerValue("integerValue")
                                 .stringValue("stringValue")
                                 .build())
                         // the properties below are optional
                         .quality("quality")
                         .timestamp(AssetPropertyTimestampProperty.builder()
                                 .timeInSeconds("timeInSeconds")
                                 // the properties below are optional
                                 .offsetInNanos("offsetInNanos")
                                 .build())
                         .build())
                 .build())
         .iotTopicPublish(IotTopicPublishProperty.builder()
                 .mqttTopic("mqttTopic")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .build())
         .lambda(LambdaProperty.builder()
                 .functionArn("functionArn")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .build())
         .sns(SnsProperty.builder()
                 .targetArn("targetArn")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .build())
         .sqs(SqsProperty.builder()
                 .queueUrl("queueUrl")
                 // the properties below are optional
                 .payload(PayloadProperty.builder()
                         .contentExpression("contentExpression")
                         .type("type")
                         .build())
                 .useBase64(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAlarmModel.AlarmActionProperty.Builder A builder for CfnAlarmModel.AlarmActionProperty
static class	CfnAlarmModel.AlarmActionProperty.Jsii$Proxy An implementation for CfnAlarmModel.AlarmActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnAlarmModel.AlarmActionProperty.Builder	builder()
default Object	getDynamoDb() Defines an action to write to the Amazon DynamoDB table that you created.
default Object	getDynamoDBv2() Defines an action to write to the Amazon DynamoDB table that you created.
default Object	getFirehose() Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
default Object	getIotEvents() Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
default 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 .
default Object	getIotTopicPublish() Information required to publish the MQTT message through the AWS IoT message broker.
default Object	getLambda() Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
default Object	getSns() `CfnAlarmModel.AlarmActionProperty.Sns`.
default Object	getSqs() Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDynamoDb

@Stability(value=Stable)
 @Nullable
default Object getDynamoDb()

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 .

getDynamoDBv2

@Stability(value=Stable)
 @Nullable
default Object getDynamoDBv2()

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 .

getFirehose

@Stability(value=Stable)
 @Nullable
default Object getFirehose()

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

getIotEvents

@Stability(value=Stable)
 @Nullable
default Object getIotEvents()

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

getIotSiteWise

@Stability(value=Stable)
 @Nullable
default 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 .

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 .

getIotTopicPublish

@Stability(value=Stable)
 @Nullable
default Object getIotTopicPublish()

Information required to publish the MQTT message through the AWS IoT message broker.

getLambda

@Stability(value=Stable)
 @Nullable
default Object getLambda()

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

getSns

@Stability(value=Stable)
 @Nullable
default Object getSns()

`CfnAlarmModel.AlarmActionProperty.Sns`.

getSqs

@Stability(value=Stable)
 @Nullable
default Object getSqs()

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

builder

@Stability(value=Stable)
static CfnAlarmModel.AlarmActionProperty.Builder builder()

Returns:

a CfnAlarmModel.AlarmActionProperty.Builder of CfnAlarmModel.AlarmActionProperty