AWS::IoTEvents::DetectorModel - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTEvents::DetectorModel

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 Amazon 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 Amazon IoT Events in the Amazon IoT Events Developer Guide.

Note

When you successfully update a detector model (using the Amazon IoT Events console, Amazon IoT Events API or CLI commands, or Amazon CloudFormation) 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 Amazon IoT Events console, Amazon IoT Events API or CLI commands, or Amazon CloudFormation) 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 Amazon CloudFormation 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 Amazon CloudFormation, 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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTEvents::DetectorModel",
  "Properties" : {
      "DetectorModelDefinition" : DetectorModelDefinition,
      "DetectorModelDescription" : String,
      "DetectorModelName" : String,
      "EvaluationMethod" : String,
      "Key" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTEvents::DetectorModel
Properties:
  DetectorModelDefinition: 
    DetectorModelDefinition
  DetectorModelDescription: String
  DetectorModelName: String
  EvaluationMethod: String
  Key: String
  RoleArn: String
  Tags: 
    - Tag

Properties

DetectorModelDefinition

Information that defines how a detector operates.

Required: Yes

Type: DetectorModelDefinition

Update requires: No interruption

DetectorModelDescription

A brief description of the detector model.

Required: No

Type: String

Maximum: 1024

Update requires: No interruption

DetectorModelName

The name of the detector model.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

EvaluationMethod

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

Required: No

Type: String

Allowed values: BATCH | SERIAL

Update requires: No interruption

Key

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

Required: No

Type: String

Pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$

Minimum: 1

Maximum: 128

Update requires: Replacement

RoleArn

The ARN of the role that grants permission to Amazon IoT Events to perform its operations.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the detector model. For example:

{"Ref": "myDetectorModel"}

For the Amazon IoT Events detector model myDetectorModel, Ref returns the name of the detector model.

For more information about using the Ref function, see Ref.

Examples

Simple Detector Model

The following example creates a simple detector model with only one state.

JSON

{
  "Description": "Simple Detector Model Template",
  "Resources": {
    "MyDetectorModel": {
      "Type": "AWS::IoTEvents::DetectorModel",
      "Properties": {
        "DetectorModelName": "myDetectorModel",
        "DetectorModelDescription": "My Detector Model created by CloudFormation",
        "Key": "myKey",
        "RoleArn": { "Fn::GetAtt" : [ "myRole", "Arn" ] },
        "DetectorModelDefinition": {
          "InitialStateName": "myInitialState",
          "States": [
            {
              "StateName": "myInitialState",
              "OnInput": {
                "Events": [
                  {
                    "EventName": "onInputPublishEvent",
                    "Condition": { "Fn::Join" : [ ".", ["$input", {"Ref": "myInput"}, "foo > 1"] ] },
                    "Actions": [
                      {
                        "IotTopicPublish": {
                          "MqttTopic": "myMqttTopic"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

YAML

---
Description: "Simple Detector Model Template"
Resources:
  MyDetectorModel:
    Type: "AWS::IoTEvents::DetectorModel"
    Properties:
      DetectorModelName: "myDetectorModel"
      DetectorModelDescription: "My Detector Model created by CloudFormation"
      Key: "myKey"
      RoleArn: !GetAtt myRole.Arn
      DetectorModelDefinition:
        InitialStateName: "myInitialState"
        States:
         - StateName: "myInitialState"
           OnInput:
             Events:
               - EventName: "onInputPublishEvent"
                 Condition: !Join [".", ["$input", {'Ref': myInput}, "foo > 1"]]
                 Actions:
                   - IotTopicPublish:
                       MqttTopic: "myMqttTopic"

Full Detector Model

The following example creates a more complete example of a detector model with two states.

JSON

{
  "Description": "Detector Model Template for CloudFormation",
  "Resources": {
    "MyDetectorModel": {
      "Type": "AWS::IoTEvents::DetectorModel",
      "Properties": {
        "DetectorModelName": "myDetectorModel",
        "DetectorModelDescription": "My Detector Model created by CloudFormation",
        "Key": "myKey",
        "RoleArn": "arn:aws:iam::123456789012:role/myIotEventsRole",
        "DetectorModelDefinition": {
          "InitialStateName": "myInitialState",
          "States": [
            {
              "StateName": "myInitialState",
              "OnEnter": {
                "Events": [
                  {
                    "EventName": "onEnterEvent",
                    "Actions": [
                      {
                        "SetVariable": {
                          "VariableName": "Variable",
                          "Value": "0"
                        }
                      }
                    ]
                  },
                  {
                    "EventName": "onEnter Event 2",
                    "Condition": "true",
                    "Actions": [
                      {
                        "SetTimer": {
                          "TimerName": "myTimer",
                          "Seconds": 60
                        }
                      }
                    ]
                  }
                ]
              },
              "OnInput": {
                "Events": [
                  {
                    "EventName": "onInputEvent",
                    "Condition": { "Fn::Join" : [ ".", ["$input", {"Ref": "myInput"}, "foo > 1"] ] },
                    "Actions": [
                      {
                        "IotTopicPublish": {
                          "MqttTopic": "myMqttTopic"
                        }
                      },
                      {
                        "ResetTimer": {
                          "TimerName": "myTimer"
                        }
                      }
                    ]
                  }
                ],
                "TransitionEvents": [
                  {
                    "EventName": "Transit to other state",
                    "Condition": "true",
                    "Actions": [
                      {
                        "Sns": {
                          "TargetArn": "arn:aws:sns:123456789012:mySnsTopic"
                        }
                      },
                      {
                        "Lambda": {
                          "FunctionArn": "arn:aws:lambda:123456789012:function:myLambdaFunction"
                        }
                      },
                      {
                        "Firehose": {
                          "DeliveryStreamName": "myStreamName",
                          "Separator": ","
                        }
                      },
                      {
                        "Sqs": {
                          "QueueUrl": "myQueueUrl",
                          "UseBase64": true
                        }
                      },
                      {
                        "IotEvents": {
                          "InputName": "myInputName"
                        }
                      }
                    ],
                    "NextState": "myOtherState"
                  }
                ]
              },
              "OnExit": {
                "Events": [
                  {
                    "EventName": "Clear timers",
                    "Condition": "1 == 1",
                    "Actions": [
                      {
                        "ClearTimer": {
                          "TimerName": "myTimer"
                        }
                      }
                    ]
                  }
                ]
              }
            },
            {
              "StateName": "myOtherState",
              "OnEnter": {
                "Events": [
                  {
                    "EventName": "onEnterEvent",
                    "Actions": [
                      {
                        "SetVariable": {
                          "VariableName": "Variable",
                          "Value": "0"
                        }
                      }
                    ]
                  },
                  {
                    "EventName": "onEnter Event 2",
                    "Condition": "true",
                    "Actions": [
                      {
                        "SetTimer": {
                          "TimerName": "myTimer",
                          "Seconds": 60
                        }
                      }
                    ]
                  }
                ]
              },
              "OnExit": {
                "Events": [
                  {
                    "EventName": "Clear timers",
                    "Condition": "1 == 1",
                    "Actions": [
                      {
                        "ClearTimer": {
                          "TimerName": "myTimer"
                        }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

YAML

---
Description: "Detector Model Template for CloudFormation"
Resources:
  MyDetectorModel:
    Type: "AWS::IoTEvents::DetectorModel"
    Properties:
      DetectorModelName: "myDetectorModel"
      DetectorModelDescription: "My Detector Model created by CloudFormation"
      Key: "myKey"
      RoleArn: "arn:aws:iam::123456789012:role/myIotEventsRole"
      DetectorModelDefinition:
        InitialStateName: "myInitialState"
        States:
          - StateName: "myInitialState"
            OnEnter:
              Events:
                - EventName: "onEnterEvent"
                  Actions:
                    - SetVariable:
                        VariableName: "Variable"
                        Value: "0"
                - EventName: "onEnter Event 2"
                  Condition: "true"
                  Actions:
                    - SetTimer:
                        TimerName: "myTimer"
                        Seconds: 60
            OnInput:
              Events:
                - EventName: "onInputEvent"
                  Condition: !Join [".", ["$input", {'Ref': myInput}, "foo > 1"]]
                  Actions:
                    - IotTopicPublish:
                        MqttTopic: "myMqttTopic"
                    - ResetTimer:
                        TimerName: "myTimer"
              TransitionEvents:
                - EventName: "Transit to other state"
                  Condition: "true"
                  Actions:
                    - Sns:
                        TargetArn: "arn:aws:sns:123456789012:mySnsTopic"
                    - Lambda:
                        FunctionArn: "arn:aws:lambda:123456789012:function:myLambdaFunction"
                    - Firehose:
                        DeliveryStreamName: "myStreamName"
                        Separator: ","
                    - Sqs:
                        QueueUrl: "myQueueUrl"
                        UseBase64: true
                    - IotEvents:
                        InputName: "myInputName"
                  NextState: "myOtherState"
            OnExit:
              Events:
                - EventName: "Clear timers"
                  Condition: "1 == 1"
                  Actions:
                    - ClearTimer:
                        TimerName: "myTimer"
          - StateName: "myOtherState"
            OnEnter:
              Events:
                - EventName: "onEnterEvent"
                  Actions:
                    - SetVariable:
                        VariableName: "Variable"
                        Value: "0"
                - EventName: "onEnter Event 2"
                  Condition: "true"
                  Actions:
                    - SetTimer:
                        TimerName: "myTimer"
                        Seconds: 60
            OnExit:
              Events:
                - EventName: "Clear timers"
                  Condition: "1 == 1"
                  Actions:
                    - ClearTimer:
                        TimerName: "myTimer"

See also