software.amazon.awscdk.services.iotevents

Interface CfnDetectorModel.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDetectorModel.ActionProperty.Jsii$Proxy

Enclosing class:

CfnDetectorModel

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

An action to be performed when the `condition` is TRUE.

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.*;
 ActionProperty actionProperty = ActionProperty.builder()
         .clearTimer(ClearTimerProperty.builder()
                 .timerName("timerName")
                 .build())
         .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()
                 .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())
                 // the properties below are optional
                 .assetId("assetId")
                 .entryId("entryId")
                 .propertyAlias("propertyAlias")
                 .propertyId("propertyId")
                 .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())
         .resetTimer(ResetTimerProperty.builder()
                 .timerName("timerName")
                 .build())
         .setTimer(SetTimerProperty.builder()
                 .timerName("timerName")
                 // the properties below are optional
                 .durationExpression("durationExpression")
                 .seconds(123)
                 .build())
         .setVariable(SetVariableProperty.builder()
                 .value("value")
                 .variableName("variableName")
                 .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	CfnDetectorModel.ActionProperty.Builder A builder for CfnDetectorModel.ActionProperty
static class	CfnDetectorModel.ActionProperty.Jsii$Proxy An implementation for CfnDetectorModel.ActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnDetectorModel.ActionProperty.Builder	builder()
default Object	getClearTimer() Information needed to clear the timer.
default Object	getDynamoDb() Writes to the DynamoDB table that you created.
default Object	getDynamoDBv2() Writes to the 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 AWS IoT Events input, which passes 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 an asset property in AWS IoT SiteWise .
default Object	getIotTopicPublish() Publishes an MQTT message with the given topic to 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	getResetTimer() Information needed to reset the timer.
default Object	getSetTimer() Information needed to set the timer.
default Object	getSetVariable() Sets a variable to a specified value.
default Object	getSns() Sends an Amazon SNS message.
default Object	getSqs() Sends an Amazon SNS message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClearTimer

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

Information needed to clear the timer.

getDynamoDb

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

Writes to the DynamoDB table that you created.

The default action payload contains all attribute-value pairs that have 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. For more information, see Actions in AWS IoT Events Developer Guide .

getDynamoDBv2

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

Writes to the DynamoDB table that you created.

The default action payload contains all attribute-value pairs that have 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. For more information, see Actions in AWS IoT Events Developer Guide .

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 AWS IoT Events input, which passes 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 an asset property in AWS IoT SiteWise .

getIotTopicPublish

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

Publishes an MQTT message with the given topic to 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.

getResetTimer

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

Information needed to reset the timer.

getSetTimer

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

Information needed to set the timer.

getSetVariable

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

Sets a variable to a specified value.

getSns

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

Sends an Amazon SNS message.

getSqs

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

Sends an Amazon SNS message.

builder

@Stability(value=Stable)
static CfnDetectorModel.ActionProperty.Builder builder()

Returns:

a CfnDetectorModel.ActionProperty.Builder of CfnDetectorModel.ActionProperty