awscc_iotevents_detector_model (Resource)

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

Schema

Required

Optional

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.

For more information, see Tag. (see below for nested schema)

Read-Only

Nested Schema for detector_model_definition

Required:

Nested Schema for detector_model_definition.states

Required:

Optional:

Nested Schema for detector_model_definition.states.on_enter

Optional:

Nested Schema for detector_model_definition.states.on_enter.events

Required:

Optional:

Nested Schema for detector_model_definition.states.on_enter.events.actions

Optional:

You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.clear_timer

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.dynamo_d_bv_2

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.dynamo_db

Required:

Optional:

If you don't specify hashKeyType, the default value is STRING.

If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.

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. (see below for nested schema)

If you don't specify this parameter, the name of the DynamoDB column is payload.

If you don't specify rangeKeyField, the default value is STRING.

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.firehose

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.iot_events

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.iot_site_wise

Required:

Optional:

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.property_value

Required:

Optional:

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.property_id.value

Optional:

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.property_id.timestamp

Required:

Optional:

Nested Schema for detector_model_definition.states.on_enter.events.actions.iot_topic_publish

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.lambda

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.reset_timer

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.set_timer

Required:

Optional:

Nested Schema for detector_model_definition.states.on_enter.events.actions.set_variable

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.sns

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_enter.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit

Optional:

Nested Schema for detector_model_definition.states.on_exit.events

Required:

Optional:

Nested Schema for detector_model_definition.states.on_exit.events.actions

Optional:

You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.clear_timer

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.dynamo_d_bv_2

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.dynamo_db

Required:

Optional:

If you don't specify hashKeyType, the default value is STRING.

If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.

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. (see below for nested schema)

If you don't specify this parameter, the name of the DynamoDB column is payload.

If you don't specify rangeKeyField, the default value is STRING.

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.firehose

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.iot_events

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.iot_site_wise

Required:

Optional:

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.property_value

Required:

Optional:

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.property_id.value

Optional:

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.property_id.timestamp

Required:

Optional:

Nested Schema for detector_model_definition.states.on_exit.events.actions.iot_topic_publish

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.lambda

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.reset_timer

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.set_timer

Required:

Optional:

Nested Schema for detector_model_definition.states.on_exit.events.actions.set_variable

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.sns

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_exit.events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input

Optional:

Nested Schema for detector_model_definition.states.on_input.events

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions

Optional:

You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.clear_timer

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.dynamo_d_bv_2

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.dynamo_db

Required:

Optional:

If you don't specify hashKeyType, the default value is STRING.

If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.

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. (see below for nested schema)

If you don't specify this parameter, the name of the DynamoDB column is payload.

If you don't specify rangeKeyField, the default value is STRING.

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.firehose

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.iot_events

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.iot_site_wise

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.property_value

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.property_id.value

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.property_id.timestamp

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.iot_topic_publish

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.lambda

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.reset_timer

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.set_timer

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.set_variable

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sns

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions

Optional:

You can use expressions for parameters that are strings. For more information, see Expressions in the AWS IoT Events Developer Guide. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.clear_timer

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.dynamo_d_bv_2

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.dynamo_db

Required:

Optional:

If you don't specify hashKeyType, the default value is STRING.

If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.

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. (see below for nested schema)

If you don't specify this parameter, the name of the DynamoDB column is payload.

If you don't specify rangeKeyField, the default value is STRING.

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.firehose

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.iot_events

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.iot_site_wise

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.property_value

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.property_id.value

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.property_id.timestamp

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.iot_topic_publish

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.lambda

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.reset_timer

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.set_timer

Required:

Optional:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.set_variable

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sns

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs

Required:

Optional:

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. (see below for nested schema)

Nested Schema for detector_model_definition.states.on_input.transition_events.actions.sqs.payload

Required:

Nested Schema for tags

Required:

Import

Import is supported using the following syntax:

$ terraform import awscc_iotevents_detector_model.example <resource ID>