software.amazon.awscdk.services.iotevents

Interface CfnDetectorModel.EventProperty

All Known Implementing Classes:

CfnDetectorModel.EventProperty.Jsii$Proxy

Enclosing class:

CfnDetectorModel

public static interface CfnDetectorModel.EventProperty

Specifies the `actions` to be performed when the `condition` evaluates to 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.*;
 EventProperty eventProperty = EventProperty.builder()
         .eventName("eventName")
         // the properties below are optional
         .actions(List.of(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()))
         .condition("condition")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDetectorModel.EventProperty.Builder	builder()
default java.lang.Object	getActions() The actions to be performed.
default java.lang.String	getCondition() Optional.
java.lang.String	getEventName() The name of the event.

Method Detail

getEventName

java.lang.String getEventName()

The name of the event.

getActions

default java.lang.Object getActions()

The actions to be performed.

getCondition

default java.lang.String getCondition()

Optional.

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

builder

static CfnDetectorModel.EventProperty.Builder builder()

Returns:

a CfnDetectorModel.EventProperty.Builder of CfnDetectorModel.EventProperty