interface DetectorModelProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.IoTEvents.DetectorModelProps
Java	software.amazon.awscdk.services.iotevents.DetectorModelProps
Python	aws_cdk.aws_iotevents.DetectorModelProps
TypeScript (source)	@aws-cdk/aws-iotevents » DetectorModelProps

Properties for defining an AWS IoT Events detector model.

Example

import * as iotevents from '@aws-cdk/aws-iotevents';
import * as actions from '@aws-cdk/aws-iotevents-actions';
import * as lambda from '@aws-cdk/aws-lambda';

declare const func: lambda.IFunction;

const input = new iotevents.Input(this, 'MyInput', {
  inputName: 'my_input', // optional
  attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],
});

const warmState = new iotevents.State({
  stateName: 'warm',
  onEnter: [{
    eventName: 'test-enter-event',
    condition: iotevents.Expression.currentInput(input),
    actions: [new actions.LambdaInvokeAction(func)], // optional
  }],
  onInput: [{ // optional
    eventName: 'test-input-event',
    actions: [new actions.LambdaInvokeAction(func)],
  }],
  onExit: [{ // optional
    eventName: 'test-exit-event',
    actions: [new actions.LambdaInvokeAction(func)],
  }],
});
const coldState = new iotevents.State({
  stateName: 'cold',
});

// transit to coldState when temperature is less than 15
warmState.transitionTo(coldState, {
  eventName: 'to_coldState', // optional property, default by combining the names of the States
  when: iotevents.Expression.lt(
    iotevents.Expression.inputAttribute(input, 'payload.temperature'),
    iotevents.Expression.fromString('15'),
  ),
  executing: [new actions.LambdaInvokeAction(func)], // optional
});
// transit to warmState when temperature is greater than or equal to 15
coldState.transitionTo(warmState, {
  when: iotevents.Expression.gte(
    iotevents.Expression.inputAttribute(input, 'payload.temperature'),
    iotevents.Expression.fromString('15'),
  ),
});

new iotevents.DetectorModel(this, 'MyDetectorModel', {
  detectorModelName: 'test-detector-model', // optional
  description: 'test-detector-model-description', // optional property, default is none
  evaluationMethod: iotevents.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,
});

Properties

Name	Type	Description
initialState🔹	State	The state that is entered at the creation of each detector.
description?🔹	string	A brief description of the detector model.
detectorKey?🔹	string	The value used to identify a detector instance.
detectorModelName?🔹	string	The name of the detector model.
evaluationMethod?🔹	EventEvaluation	Information about the order in which events are evaluated and how actions are executed.
role?🔹	IRole	The role that grants permission to AWS IoT Events to perform its operations.

---

initialState🔹

Type: State

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

---

description?🔹

Type: string (optional, default: none)

A brief description of the detector model.

---

detectorKey?🔹

Type: string (optional, default: none (single detector instance will be created and all inputs will be routed to it))

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.

---

detectorModelName?🔹

Type: string (optional, default: CloudFormation will generate a unique name of the detector model)

The name of the detector model.

---

evaluationMethod?🔹

Type: EventEvaluation (optional, default: EventEvaluation.BATCH)

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.

---

role?🔹

Type: IRole (optional, default: a role will be created with default permissions)

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