Class DetectorModelProps.Builder

java.lang.Object
software.amazon.awscdk.services.iotevents.DetectorModelProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<DetectorModelProps>
Enclosing interface:
DetectorModelProps

@Stability(Experimental) public static final class DetectorModelProps.Builder extends Object implements software.amazon.jsii.Builder<DetectorModelProps>
A builder for DetectorModelProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • initialState

      @Stability(Experimental) public DetectorModelProps.Builder initialState(State initialState)
      Parameters:
      initialState - The state that is entered at the creation of each detector. This parameter is required.
      Returns:
      this
    • description

      @Stability(Experimental) public DetectorModelProps.Builder description(String description)
      Parameters:
      description - A brief description of the detector model.
      Returns:
      this
    • detectorKey

      @Stability(Experimental) public DetectorModelProps.Builder detectorKey(String detectorKey)
      Parameters:
      detectorKey - 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.

      Returns:
      this
    • detectorModelName

      @Stability(Experimental) public DetectorModelProps.Builder detectorModelName(String detectorModelName)
      Parameters:
      detectorModelName - The name of the detector model.
      Returns:
      this
    • evaluationMethod

      @Stability(Experimental) public DetectorModelProps.Builder evaluationMethod(EventEvaluation evaluationMethod)
      Parameters:
      evaluationMethod - Information about the order in which events are evaluated and how actions are executed. When setting to SERIAL, variables are updated and event conditions are evaluated in the order that the events are defined. When setting to BATCH, variables within a state are updated and events within a state are performed only after all event conditions are evaluated.
      Returns:
      this
    • role

      @Stability(Experimental) public DetectorModelProps.Builder role(IRole role)
      Parameters:
      role - The role that grants permission to AWS IoT Events to perform its operations.
      Returns:
      this
    • build

      @Stability(Experimental) public DetectorModelProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<DetectorModelProps>
      Returns:
      a new instance of DetectorModelProps
      Throws:
      NullPointerException - if any required attribute was not provided