awscc_iotevents_alarm_model (Resource)

The AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.

Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.

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 alarm 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 alarm_rule

Optional:

Nested Schema for alarm_rule.simple_rule

Required:

Nested Schema for alarm_capabilities

Optional:

Nested Schema for alarm_capabilities.acknowledge_flow

Optional:

Nested Schema for alarm_capabilities.initialization_configuration

Optional:

Nested Schema for alarm_event_actions

Optional:

Nested Schema for alarm_event_actions.alarm_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 alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.dynamo_d_bv_2.payload

Required:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.dynamo_db.payload

Required:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.firehose.payload

Required:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.iot_events.payload

Required:

Nested Schema for alarm_event_actions.alarm_actions.iot_site_wise

Optional:

Nested Schema for alarm_event_actions.alarm_actions.iot_site_wise.property_value

Required:

Optional:

Nested Schema for alarm_event_actions.alarm_actions.iot_site_wise.property_value.value

Optional:

Nested Schema for alarm_event_actions.alarm_actions.iot_site_wise.property_value.timestamp

Required:

Optional:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.iot_topic_publish.payload

Required:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.lambda.payload

Required:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.sns.payload

Required:

Nested Schema for alarm_event_actions.alarm_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 alarm 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 alarm_event_actions.alarm_actions.sqs.payload

Required:

Nested Schema for tags

Required:

Import

Import is supported using the following syntax:

$ terraform import awscc_iotevents_alarm_model.example <resource ID>