latest--aws-iotevents-detectormodel
sharedThe 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 AWS IoT Events in the AWS IoT Events Developer Guide.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git
Properties
Information that defines how a detector operates.
2 nested properties
The state that is entered at the creation of each detector (instance).
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
A brief description of the detector model.
The name of the detector model.
Information about the order in which events are evaluated and how actions are executed.
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.
Definitions
Information that defines how a detector operates.
The state that is entered at the creation of each detector (instance).
Information that defines a state of a detector.
The name of the state.
When entering this state, perform these actions if the condition is TRUE.
1 nested properties
Specifies the actions that are performed when the state is entered and the condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
1 nested properties
Specifies the actions that are performed when the state is exited and the condition is TRUE.
When an input is received and the condition is TRUE, perform the specified actions.
2 nested properties
Specifies the actions performed when the condition evaluates to TRUE.
Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.
When entering this state, perform these actions if the condition is TRUE.
Specifies the actions that are performed when the state is entered and the condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
Specifies the actions that are performed when the state is exited and the condition is TRUE.
When an input is received and the condition is TRUE, perform the specified actions.
Specifies the actions performed when the condition evaluates to TRUE.
Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.
Specifies the actions to be performed when the condition evaluates to TRUE.
The name of the event.
The actions to be performed.
The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
Specifies the actions performed and the next state entered when a condition evaluates to TRUE.
A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.
The name of the event.
The next state to enter.
The actions to be performed.
The actions to be performed.
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
10 nested properties
The name of the hash key (also called the partition key).
The value of the hash key (also called the partition key).
The name of the DynamoDB table.
The data type for the hash key (also called the partition key). You can specify the following values:
-
STRING- The hash key is a string. -
NUMBER- The hash key is a number.
If you don't specify hashKeyType, the default value is STRING.
The type of operation to perform. You can specify the following values:
-
INSERT- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. -
UPDATE- Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. -
DELETE- Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is payload.
The name of the range key (also called the sort key).
The data type for the range key (also called the sort key), You can specify the following values:
-
STRING- The range key is a string. -
NUMBER- The range key is number.
If you don't specify rangeKeyField, the default value is STRING.
The value of the range key (also called the sort key).
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide.
2 nested properties
The name of the DynamoDB table.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
3 nested properties
The name of the Kinesis Data Firehose delivery stream where the data is written.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
2 nested properties
The name of the AWS IoT Events input where the data is sent.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
5 nested properties
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
3 nested properties
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
The ID of the asset that has the specified property. You can specify an expression.
A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.
The alias of the asset property. You can also specify an expression.
The ID of the asset property. You can specify an expression.
Information required to publish the MQTT message through the AWS IoT message broker.
2 nested properties
The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
2 nested properties
The ARN of the Lambda function that is executed.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.
1 nested properties
The name of the timer to reset.
Information needed to set the timer.
3 nested properties
The name of the timer.
The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.
The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
Information about the variable and its new value.
2 nested properties
The new value of the variable.
The name of the variable.
Information required to publish the Amazon SNS message.
2 nested properties
The ARN of the Amazon SNS target where the message is sent.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
3 nested properties
The URL of the SQS queue where the data is written.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
Information needed to clear the timer.
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
The name of the hash key (also called the partition key).
The value of the hash key (also called the partition key).
The name of the DynamoDB table.
The data type for the hash key (also called the partition key). You can specify the following values:
-
STRING- The hash key is a string. -
NUMBER- The hash key is a number.
If you don't specify hashKeyType, the default value is STRING.
The type of operation to perform. You can specify the following values:
-
INSERT- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. -
UPDATE- Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. -
DELETE- Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is payload.
The name of the range key (also called the sort key).
The data type for the range key (also called the sort key), You can specify the following values:
-
STRING- The range key is a string. -
NUMBER- The range key is number.
If you don't specify rangeKeyField, the default value is STRING.
The value of the range key (also called the sort key).
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide.
The name of the DynamoDB table.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
The name of the Kinesis Data Firehose delivery stream where the data is written.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
The name of the AWS IoT Events input where the data is sent.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
3 nested properties
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
4 nested properties
The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.
The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.
The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.
The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.
The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
2 nested properties
The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.
The ID of the asset that has the specified property. You can specify an expression.
A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.
The alias of the asset property. You can also specify an expression.
The ID of the asset property. You can specify an expression.
Information required to publish the MQTT message through the AWS IoT message broker.
The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
The ARN of the Lambda function that is executed.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.
The name of the timer to reset.
Information needed to set the timer.
The name of the timer.
The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.
The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
Information about the variable and its new value.
The new value of the variable.
The name of the variable.
Information required to publish the Amazon SNS message.
The ARN of the Amazon SNS target where the message is sent.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
The URL of the SQS queue where the data is written.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
2 nested properties
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
4 nested properties
The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.
The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.
The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.
The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.
The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
2 nested properties
The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.
The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.
The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.
The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.
The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.
The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
The value of the payload type can be either STRING or JSON.
Tags to be applied to Input.
Key of the Tag.
Value of the Tag.