software.amazon.awscdk.services.iotevents

Class DetectorModel.Builder

java.lang.Object

software.amazon.awscdk.services.iotevents.DetectorModel.Builder

Enclosing class:

DetectorModel

public static final class DetectorModel.Builder
extends java.lang.Object

(experimental) A fluent builder for DetectorModel.

Method Summary

Modifier and Type	Method and Description
DetectorModel	build()
static DetectorModel.Builder	create(software.constructs.Construct scope, java.lang.String id)
DetectorModel.Builder	description(java.lang.String description) (experimental) A brief description of the detector model.
DetectorModel.Builder	detectorKey(java.lang.String detectorKey) (experimental) The value used to identify a detector instance.
DetectorModel.Builder	detectorModelName(java.lang.String detectorModelName) (experimental) The name of the detector model.
DetectorModel.Builder	evaluationMethod(EventEvaluation evaluationMethod) (experimental) Information about the order in which events are evaluated and how actions are executed.
DetectorModel.Builder	initialState(State initialState) (experimental) The state that is entered at the creation of each detector.
DetectorModel.Builder	role(IRole role) (experimental) The role that grants permission to AWS IoT Events to perform its operations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static DetectorModel.Builder create(software.constructs.Construct scope,
                                           java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DetectorModel.Builder.

initialState

public DetectorModel.Builder initialState(State initialState)

(experimental) The state that is entered at the creation of each detector.

Parameters:

initialState - The state that is entered at the creation of each detector. This parameter is required.

Returns:

this

description

public DetectorModel.Builder description(java.lang.String description)

(experimental) A brief description of the detector model.

Default: none

Parameters:

description - A brief description of the detector model. This parameter is required.

Returns:

this

detectorKey

public DetectorModel.Builder detectorKey(java.lang.String detectorKey)

(experimental) 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.

Default: - none (single detector instance will be created and all inputs will be routed to it)

Parameters:

detectorKey - The value used to identify a detector instance. This parameter is required.

Returns:

this

detectorModelName

public DetectorModel.Builder detectorModelName(java.lang.String detectorModelName)

(experimental) The name of the detector model.

Default: - CloudFormation will generate a unique name of the detector model

Parameters:

detectorModelName - The name of the detector model. This parameter is required.

Returns:

this

evaluationMethod

public DetectorModel.Builder evaluationMethod(EventEvaluation evaluationMethod)

(experimental) 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.

Default: EventEvaluation.BATCH

Parameters:

evaluationMethod - Information about the order in which events are evaluated and how actions are executed. This parameter is required.

Returns:

this

role

public DetectorModel.Builder role(IRole role)

(experimental) The role that grants permission to AWS IoT Events to perform its operations.

Default: - a role will be created with default permissions

Parameters:

role - The role that grants permission to AWS IoT Events to perform its operations. This parameter is required.

Returns:

this

build

public DetectorModel build()