DetectorModelArgs

data class DetectorModelArgs(val detectorModelDefinition: Output<DetectorModelDefinitionArgs>? = null, val detectorModelDescription: Output<String>? = null, val detectorModelName: Output<String>? = null, val evaluationMethod: Output<DetectorModelEvaluationMethod>? = null, val key: Output<String>? = null, val roleArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DetectorModelArgs>

The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a detector model (a model of your equipment or process) using states. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see How to Use in the Developer Guide. When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's `state`, and the values of any variables and timers are reset.) When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.) If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset. Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.

Constructors

Link copied to clipboard
constructor(detectorModelDefinition: Output<DetectorModelDefinitionArgs>? = null, detectorModelDescription: Output<String>? = null, detectorModelName: Output<String>? = null, evaluationMethod: Output<DetectorModelEvaluationMethod>? = null, key: Output<String>? = null, roleArn: Output<String>? = null, tags: Output<List<TagArgs>>? = null)

Properties

Link copied to clipboard

Information that defines how a detector operates.

Link copied to clipboard
val detectorModelDescription: Output<String>? = null

A brief description of the detector model.

Link copied to clipboard
val detectorModelName: Output<String>? = null

The name of the detector model.

Link copied to clipboard

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

Link copied to clipboard
val key: Output<String>? = null

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. ITE 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.

Link copied to clipboard
val roleArn: Output<String>? = null

The ARN of the role that grants permission to ITE to perform its operations.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

An array of key-value pairs to apply to this resource. For more information, see Tag.

Functions

Link copied to clipboard
open override fun toJava(): DetectorModelArgs