Package software.amazon.awscdk.services.iotevents.alpha

Class DetectorModel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.iotevents.alpha.DetectorModel
All Implemented Interfaces:
IResource, IDetectorModel, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:50.192Z") @Stability(Experimental) public class DetectorModel extends Resource implements IDetectorModel
(experimental) Defines an AWS IoT Events detector model in this stack.

Example: 

 import software.amazon.awscdk.services.iotevents.alpha.*;
 import software.amazon.awscdk.services.iotevents.actions.alpha.*;
 import software.amazon.awscdk.services.lambda.*;
 IFunction func;
 Input input = Input.Builder.create(this, "MyInput")
         .inputName("my_input") // optional
         .attributeJsonPaths(List.of("payload.deviceId", "payload.temperature"))
         .build();
 State warmState = State.Builder.create()
         .stateName("warm")
         .onEnter(List.of(Event.builder()
                 .eventName("test-enter-event")
                 .condition(Expression.currentInput(input))
                 .actions(List.of(new LambdaInvokeAction(func)))
                 .build()))
         .onInput(List.of(Event.builder() // optional
                 .eventName("test-input-event")
                 .actions(List.of(new LambdaInvokeAction(func))).build()))
         .onExit(List.of(Event.builder() // optional
                 .eventName("test-exit-event")
                 .actions(List.of(new LambdaInvokeAction(func))).build()))
         .build();
 State coldState = State.Builder.create()
         .stateName("cold")
         .build();
 // transit to coldState when temperature is less than 15
 warmState.transitionTo(coldState, TransitionOptions.builder()
         .eventName("to_coldState") // optional property, default by combining the names of the States
         .when(Expression.lt(Expression.inputAttribute(input, "payload.temperature"), Expression.fromString("15")))
         .executing(List.of(new LambdaInvokeAction(func)))
         .build());
 // transit to warmState when temperature is greater than or equal to 15
 coldState.transitionTo(warmState, TransitionOptions.builder()
         .when(Expression.gte(Expression.inputAttribute(input, "payload.temperature"), Expression.fromString("15")))
         .build());
 DetectorModel.Builder.create(this, "MyDetectorModel")
         .detectorModelName("test-detector-model") // optional
         .description("test-detector-model-description") // optional property, default is none
         .evaluationMethod(EventEvaluation.SERIAL) // optional property, default is iotevents.EventEvaluation.BATCH
         .detectorKey("payload.deviceId") // optional property, default is none and single detector instance will be created and all inputs will be routed to it
         .initialState(warmState)
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • DetectorModel

      protected DetectorModel(software.amazon.jsii.JsiiObjectRef objRef)

    • DetectorModel

      protected DetectorModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • DetectorModel

      @Stability(Experimental) public DetectorModel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DetectorModelProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromDetectorModelName

      @Stability(Experimental) @NotNull public static IDetectorModel fromDetectorModelName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String detectorModelName)
      (experimental) Import an existing detector model.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      detectorModelName - This parameter is required.

    • getDetectorModelName

      @Stability(Experimental) @NotNull public String getDetectorModelName()
      (experimental) The name of the detector model.
      Specified by:
      getDetectorModelName in interface IDetectorModel