All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDetectorModelMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:00.341Z") @Stability(Stable) public interface CfnDetectorModelMixinProps extends software.amazon.jsii.JsiiSerializable

Properties for CfnDetectorModelPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotevents.*;
 CfnDetectorModelMixinProps cfnDetectorModelMixinProps = CfnDetectorModelMixinProps.builder()
         .detectorModelDefinition(DetectorModelDefinitionProperty.builder()
                 .initialStateName("initialStateName")
                 .states(List.of(StateProperty.builder()
                         .onEnter(OnEnterProperty.builder()
                                 .events(List.of(EventProperty.builder()
                                         .actions(List.of(ActionProperty.builder()
                                                 .clearTimer(ClearTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .dynamoDb(DynamoDBProperty.builder()
                                                         .hashKeyField("hashKeyField")
                                                         .hashKeyType("hashKeyType")
                                                         .hashKeyValue("hashKeyValue")
                                                         .operation("operation")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .payloadField("payloadField")
                                                         .rangeKeyField("rangeKeyField")
                                                         .rangeKeyType("rangeKeyType")
                                                         .rangeKeyValue("rangeKeyValue")
                                                         .tableName("tableName")
                                                         .build())
                                                 .dynamoDBv2(DynamoDBv2Property.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .tableName("tableName")
                                                         .build())
                                                 .firehose(FirehoseProperty.builder()
                                                         .deliveryStreamName("deliveryStreamName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .separator("separator")
                                                         .build())
                                                 .iotEvents(IotEventsProperty.builder()
                                                         .inputName("inputName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .iotSiteWise(IotSiteWiseProperty.builder()
                                                         .assetId("assetId")
                                                         .entryId("entryId")
                                                         .propertyAlias("propertyAlias")
                                                         .propertyId("propertyId")
                                                         .propertyValue(AssetPropertyValueProperty.builder()
                                                                 .quality("quality")
                                                                 .timestamp(AssetPropertyTimestampProperty.builder()
                                                                         .offsetInNanos("offsetInNanos")
                                                                         .timeInSeconds("timeInSeconds")
                                                                         .build())
                                                                 .value(AssetPropertyVariantProperty.builder()
                                                                         .booleanValue("booleanValue")
                                                                         .doubleValue("doubleValue")
                                                                         .integerValue("integerValue")
                                                                         .stringValue("stringValue")
                                                                         .build())
                                                                 .build())
                                                         .build())
                                                 .iotTopicPublish(IotTopicPublishProperty.builder()
                                                         .mqttTopic("mqttTopic")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .lambda(LambdaProperty.builder()
                                                         .functionArn("functionArn")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .resetTimer(ResetTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .setTimer(SetTimerProperty.builder()
                                                         .durationExpression("durationExpression")
                                                         .seconds(123)
                                                         .timerName("timerName")
                                                         .build())
                                                 .setVariable(SetVariableProperty.builder()
                                                         .value("value")
                                                         .variableName("variableName")
                                                         .build())
                                                 .sns(SnsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .targetArn("targetArn")
                                                         .build())
                                                 .sqs(SqsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .queueUrl("queueUrl")
                                                         .useBase64(false)
                                                         .build())
                                                 .build()))
                                         .condition("condition")
                                         .eventName("eventName")
                                         .build()))
                                 .build())
                         .onExit(OnExitProperty.builder()
                                 .events(List.of(EventProperty.builder()
                                         .actions(List.of(ActionProperty.builder()
                                                 .clearTimer(ClearTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .dynamoDb(DynamoDBProperty.builder()
                                                         .hashKeyField("hashKeyField")
                                                         .hashKeyType("hashKeyType")
                                                         .hashKeyValue("hashKeyValue")
                                                         .operation("operation")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .payloadField("payloadField")
                                                         .rangeKeyField("rangeKeyField")
                                                         .rangeKeyType("rangeKeyType")
                                                         .rangeKeyValue("rangeKeyValue")
                                                         .tableName("tableName")
                                                         .build())
                                                 .dynamoDBv2(DynamoDBv2Property.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .tableName("tableName")
                                                         .build())
                                                 .firehose(FirehoseProperty.builder()
                                                         .deliveryStreamName("deliveryStreamName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .separator("separator")
                                                         .build())
                                                 .iotEvents(IotEventsProperty.builder()
                                                         .inputName("inputName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .iotSiteWise(IotSiteWiseProperty.builder()
                                                         .assetId("assetId")
                                                         .entryId("entryId")
                                                         .propertyAlias("propertyAlias")
                                                         .propertyId("propertyId")
                                                         .propertyValue(AssetPropertyValueProperty.builder()
                                                                 .quality("quality")
                                                                 .timestamp(AssetPropertyTimestampProperty.builder()
                                                                         .offsetInNanos("offsetInNanos")
                                                                         .timeInSeconds("timeInSeconds")
                                                                         .build())
                                                                 .value(AssetPropertyVariantProperty.builder()
                                                                         .booleanValue("booleanValue")
                                                                         .doubleValue("doubleValue")
                                                                         .integerValue("integerValue")
                                                                         .stringValue("stringValue")
                                                                         .build())
                                                                 .build())
                                                         .build())
                                                 .iotTopicPublish(IotTopicPublishProperty.builder()
                                                         .mqttTopic("mqttTopic")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .lambda(LambdaProperty.builder()
                                                         .functionArn("functionArn")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .resetTimer(ResetTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .setTimer(SetTimerProperty.builder()
                                                         .durationExpression("durationExpression")
                                                         .seconds(123)
                                                         .timerName("timerName")
                                                         .build())
                                                 .setVariable(SetVariableProperty.builder()
                                                         .value("value")
                                                         .variableName("variableName")
                                                         .build())
                                                 .sns(SnsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .targetArn("targetArn")
                                                         .build())
                                                 .sqs(SqsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .queueUrl("queueUrl")
                                                         .useBase64(false)
                                                         .build())
                                                 .build()))
                                         .condition("condition")
                                         .eventName("eventName")
                                         .build()))
                                 .build())
                         .onInput(OnInputProperty.builder()
                                 .events(List.of(EventProperty.builder()
                                         .actions(List.of(ActionProperty.builder()
                                                 .clearTimer(ClearTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .dynamoDb(DynamoDBProperty.builder()
                                                         .hashKeyField("hashKeyField")
                                                         .hashKeyType("hashKeyType")
                                                         .hashKeyValue("hashKeyValue")
                                                         .operation("operation")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .payloadField("payloadField")
                                                         .rangeKeyField("rangeKeyField")
                                                         .rangeKeyType("rangeKeyType")
                                                         .rangeKeyValue("rangeKeyValue")
                                                         .tableName("tableName")
                                                         .build())
                                                 .dynamoDBv2(DynamoDBv2Property.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .tableName("tableName")
                                                         .build())
                                                 .firehose(FirehoseProperty.builder()
                                                         .deliveryStreamName("deliveryStreamName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .separator("separator")
                                                         .build())
                                                 .iotEvents(IotEventsProperty.builder()
                                                         .inputName("inputName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .iotSiteWise(IotSiteWiseProperty.builder()
                                                         .assetId("assetId")
                                                         .entryId("entryId")
                                                         .propertyAlias("propertyAlias")
                                                         .propertyId("propertyId")
                                                         .propertyValue(AssetPropertyValueProperty.builder()
                                                                 .quality("quality")
                                                                 .timestamp(AssetPropertyTimestampProperty.builder()
                                                                         .offsetInNanos("offsetInNanos")
                                                                         .timeInSeconds("timeInSeconds")
                                                                         .build())
                                                                 .value(AssetPropertyVariantProperty.builder()
                                                                         .booleanValue("booleanValue")
                                                                         .doubleValue("doubleValue")
                                                                         .integerValue("integerValue")
                                                                         .stringValue("stringValue")
                                                                         .build())
                                                                 .build())
                                                         .build())
                                                 .iotTopicPublish(IotTopicPublishProperty.builder()
                                                         .mqttTopic("mqttTopic")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .lambda(LambdaProperty.builder()
                                                         .functionArn("functionArn")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .resetTimer(ResetTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .setTimer(SetTimerProperty.builder()
                                                         .durationExpression("durationExpression")
                                                         .seconds(123)
                                                         .timerName("timerName")
                                                         .build())
                                                 .setVariable(SetVariableProperty.builder()
                                                         .value("value")
                                                         .variableName("variableName")
                                                         .build())
                                                 .sns(SnsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .targetArn("targetArn")
                                                         .build())
                                                 .sqs(SqsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .queueUrl("queueUrl")
                                                         .useBase64(false)
                                                         .build())
                                                 .build()))
                                         .condition("condition")
                                         .eventName("eventName")
                                         .build()))
                                 .transitionEvents(List.of(TransitionEventProperty.builder()
                                         .actions(List.of(ActionProperty.builder()
                                                 .clearTimer(ClearTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .dynamoDb(DynamoDBProperty.builder()
                                                         .hashKeyField("hashKeyField")
                                                         .hashKeyType("hashKeyType")
                                                         .hashKeyValue("hashKeyValue")
                                                         .operation("operation")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .payloadField("payloadField")
                                                         .rangeKeyField("rangeKeyField")
                                                         .rangeKeyType("rangeKeyType")
                                                         .rangeKeyValue("rangeKeyValue")
                                                         .tableName("tableName")
                                                         .build())
                                                 .dynamoDBv2(DynamoDBv2Property.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .tableName("tableName")
                                                         .build())
                                                 .firehose(FirehoseProperty.builder()
                                                         .deliveryStreamName("deliveryStreamName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .separator("separator")
                                                         .build())
                                                 .iotEvents(IotEventsProperty.builder()
                                                         .inputName("inputName")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .iotSiteWise(IotSiteWiseProperty.builder()
                                                         .assetId("assetId")
                                                         .entryId("entryId")
                                                         .propertyAlias("propertyAlias")
                                                         .propertyId("propertyId")
                                                         .propertyValue(AssetPropertyValueProperty.builder()
                                                                 .quality("quality")
                                                                 .timestamp(AssetPropertyTimestampProperty.builder()
                                                                         .offsetInNanos("offsetInNanos")
                                                                         .timeInSeconds("timeInSeconds")
                                                                         .build())
                                                                 .value(AssetPropertyVariantProperty.builder()
                                                                         .booleanValue("booleanValue")
                                                                         .doubleValue("doubleValue")
                                                                         .integerValue("integerValue")
                                                                         .stringValue("stringValue")
                                                                         .build())
                                                                 .build())
                                                         .build())
                                                 .iotTopicPublish(IotTopicPublishProperty.builder()
                                                         .mqttTopic("mqttTopic")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .lambda(LambdaProperty.builder()
                                                         .functionArn("functionArn")
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .build())
                                                 .resetTimer(ResetTimerProperty.builder()
                                                         .timerName("timerName")
                                                         .build())
                                                 .setTimer(SetTimerProperty.builder()
                                                         .durationExpression("durationExpression")
                                                         .seconds(123)
                                                         .timerName("timerName")
                                                         .build())
                                                 .setVariable(SetVariableProperty.builder()
                                                         .value("value")
                                                         .variableName("variableName")
                                                         .build())
                                                 .sns(SnsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .targetArn("targetArn")
                                                         .build())
                                                 .sqs(SqsProperty.builder()
                                                         .payload(PayloadProperty.builder()
                                                                 .contentExpression("contentExpression")
                                                                 .type("type")
                                                                 .build())
                                                         .queueUrl("queueUrl")
                                                         .useBase64(false)
                                                         .build())
                                                 .build()))
                                         .condition("condition")
                                         .eventName("eventName")
                                         .nextState("nextState")
                                         .build()))
                                 .build())
                         .stateName("stateName")
                         .build()))
                 .build())
         .detectorModelDescription("detectorModelDescription")
         .detectorModelName("detectorModelName")
         .evaluationMethod("evaluationMethod")
         .key("key")
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDetectorModelMixinProps.Builder

A builder for CfnDetectorModelMixinProps

static final class

CfnDetectorModelMixinProps.Jsii$Proxy

An implementation for CfnDetectorModelMixinProps
Method Summary

Modifier and Type

Method

Description

static CfnDetectorModelMixinProps.Builder

builder()

default Object

getDetectorModelDefinition()

Information that defines how a detector operates.

default String

getDetectorModelDescription()

A brief description of the detector model.

default String

getDetectorModelName()

The name of the detector model.

default String

getEvaluationMethod()

Information about the order in which events are evaluated and how actions are executed.

default String

getKey()

The value used to identify a detector instance.

default Object

getRoleArn()

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

default List<CfnTag>

getTags()

An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getDetectorModelDefinition
  
  @Stability(Stable) @Nullable default Object getDetectorModelDefinition()
  
  Information that defines how a detector operates.
  Returns union: either IResolvable or CfnDetectorModelPropsMixin.DetectorModelDefinitionProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition
- getDetectorModelDescription
  
  @Stability(Stable) @Nullable default String getDetectorModelDescription()
  
  A brief description of the detector model.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldescription
- getDetectorModelName
  
  @Stability(Stable) @Nullable default String getDetectorModelName()
  
  The name of the detector model.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodelname
- getEvaluationMethod
  
  @Stability(Stable) @Nullable default String getEvaluationMethod()
  
  Information about the order in which events are evaluated and how actions are executed.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod
- getKey
  
  @Stability(Stable) @Nullable default String getKey()
  
  The value used to identify a detector instance.
  When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
  This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key
- getRoleArn
  
  @Stability(Stable) @Nullable default Object getRoleArn()
  
  The ARN of the role that grants permission to AWS IoT Events to perform its operations.
  Returns union: either String or IRoleRef
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-rolearn
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  An array of key-value pairs to apply to this resource.
  For more information, see Tag .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-tags
- builder
  
  @Stability(Stable) static CfnDetectorModelMixinProps.Builder builder()
  
  Returns:
  
  a CfnDetectorModelMixinProps.Builder of CfnDetectorModelMixinProps

Interface CfnDetectorModelMixinProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDetectorModelDefinition

getDetectorModelDescription

getDetectorModelName

getEvaluationMethod

getKey

getRoleArn

getTags

builder