CfnDetectorModel.ActionProperty

All Known Implementing Classes:: CfnDetectorModel.ActionProperty.Jsii$Proxy

Enclosing class:: CfnDetectorModel

public static interface CfnDetectorModel.ActionProperty

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

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnDetectorModel.ActionProperty.Builder`	`builder()`
`default java.lang.Object`	`getClearTimer()` Information needed to clear the timer.
`default java.lang.Object`	`getDynamoDb()` Writes to the DynamoDB table that you created.
`default java.lang.Object`	`getDynamoDBv2()` Writes to the DynamoDB table that you created.
`default java.lang.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 java.lang.Object`	`getIotEvents()` Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
`default java.lang.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 java.lang.Object`	`getIotTopicPublish()` Publishes an MQTT message with the given topic to the AWS IoT message broker.
`default java.lang.Object`	`getLambda()` Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
`default java.lang.Object`	`getResetTimer()` Information needed to reset the timer.
`default java.lang.Object`	`getSetTimer()` Information needed to set the timer.
`default java.lang.Object`	`getSetVariable()` Sets a variable to a specified value.
`default java.lang.Object`	`getSns()` Sends an Amazon SNS message.
`default java.lang.Object`	`getSqs()` Sends an Amazon SNS message.

- Method Detail
  - getClearTimer
```
default java.lang.Object getClearTimer()
```
    Information needed to clear the timer.
  - getDynamoDb
```
default java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.lang.Object getIotEvents()
```
    Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
  - getIotSiteWise
```
default java.lang.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
```
default java.lang.Object getIotTopicPublish()
```
    Publishes an MQTT message with the given topic to the AWS IoT message broker.
  - getLambda
```
default java.lang.Object getLambda()
```
    Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
  - getResetTimer
```
default java.lang.Object getResetTimer()
```
    Information needed to reset the timer.
  - getSetTimer
```
default java.lang.Object getSetTimer()
```
    Information needed to set the timer.
  - getSetVariable
```
default java.lang.Object getSetVariable()
```
    Sets a variable to a specified value.
  - getSns
```
default java.lang.Object getSns()
```
    Sends an Amazon SNS message.
  - getSqs
```
default java.lang.Object getSqs()
```
    Sends an Amazon SNS message.
  - builder
```
static CfnDetectorModel.ActionProperty.Builder builder()
```
    Returns:
    
    a CfnDetectorModel.ActionProperty.Builder of CfnDetectorModel.ActionProperty

Interface CfnDetectorModel.ActionProperty

Nested Class Summary

Method Summary

Method Detail

getClearTimer

getDynamoDb

getDynamoDBv2

getFirehose

getIotEvents

getIotSiteWise

getIotTopicPublish

getLambda

getResetTimer

getSetTimer

getSetVariable

getSns

getSqs

builder