--- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_iotevents_alarm_model Resource - terraform-provider-awscc" subcategory: "" description: |- 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. --- # 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 - `alarm_rule` (Attributes) Defines when your alarm is invoked. (see [below for nested schema](#nestedatt--alarm_rule)) - `role_arn` (String) The ARN of the role that grants permission to AWS IoT Events to perform its operations. ### Optional - `alarm_capabilities` (Attributes) Contains the configuration information of alarm state changes (see [below for nested schema](#nestedatt--alarm_capabilities)) - `alarm_event_actions` (Attributes) Contains information about one or more alarm actions. (see [below for nested schema](#nestedatt--alarm_event_actions)) - `alarm_model_description` (String) A brief description of the alarm model. - `alarm_model_name` (String) The name of the alarm model. - `key` (String) The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm 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 alarm instance, the device must send a message payload that contains the same attribute-value. - `severity` (Number) A non-negative integer that reflects the severity level of the alarm. - `tags` (Attributes List) An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). (see [below for nested schema](#nestedatt--tags)) ### Read-Only - `id` (String) Uniquely identifies the resource. ### Nested Schema for `alarm_rule` Required: - `simple_rule` (Attributes) A rule that compares an input property value to a threshold value with a comparison operator. (see [below for nested schema](#nestedatt--alarm_rule--simple_rule)) ### Nested Schema for `alarm_rule.simple_rule` Required: - `comparison_operator` (String) The comparison operator. - `input_property` (String) The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property. - `threshold` (String) The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute. ### Nested Schema for `alarm_capabilities` Optional: - `acknowledge_flow` (Attributes) Specifies whether to get notified for alarm state changes. (see [below for nested schema](#nestedatt--alarm_capabilities--acknowledge_flow)) - `initialization_configuration` (Attributes) Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. (see [below for nested schema](#nestedatt--alarm_capabilities--initialization_configuration)) ### Nested Schema for `alarm_capabilities.acknowledge_flow` Optional: - `enabled` (Boolean) The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range. ### Nested Schema for `alarm_capabilities.initialization_configuration` Optional: - `disabled_on_initialization` (Boolean) The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE. ### Nested Schema for `alarm_event_actions` Optional: - `alarm_actions` (Attributes List) Specifies one or more supported actions to receive notifications when the alarm state changes. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions)) ### Nested Schema for `alarm_event_actions.alarm_actions` Optional: - `dynamo_d_bv_2` (Attributes) 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 alarm model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). 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](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--dynamo_d_bv_2)) - `dynamo_db` (Attributes) Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the alarm model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide*. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--dynamo_db)) - `firehose` (Attributes) Sends information about the alarm model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--firehose)) - `iot_events` (Attributes) Sends an AWS IoT Events input, passing in information about the alarm model instance and the event that triggered the action. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_events)) - `iot_site_wise` (Attributes) Sends information about the alarm model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_site_wise)) - `iot_topic_publish` (Attributes) Information required to publish the MQTT message through the AWS IoT message broker. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_topic_publish)) - `lambda` (Attributes) (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--lambda)) - `sns` (Attributes) Information required to publish the Amazon SNS message. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--sns)) - `sqs` (Attributes) (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--sqs)) ### Nested Schema for `alarm_event_actions.alarm_actions.dynamo_d_bv_2` Optional: - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--dynamo_d_bv_2--payload)) - `table_name` (String) The name of the DynamoDB table. ### Nested Schema for `alarm_event_actions.alarm_actions.dynamo_d_bv_2.table_name` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.dynamo_db` Optional: - `hash_key_field` (String) The name of the hash key (also called the partition key). - `hash_key_type` (String) 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`. - `hash_key_value` (String) The value of the hash key (also called the partition key). - `operation` (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. - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--dynamo_db--payload)) - `payload_field` (String) 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`. - `range_key_field` (String) The name of the range key (also called the sort key). - `range_key_type` (String) 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`. - `range_key_value` (String) The value of the range key (also called the sort key). - `table_name` (String) The name of the DynamoDB table. ### Nested Schema for `alarm_event_actions.alarm_actions.dynamo_db.table_name` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.firehose` Optional: - `delivery_stream_name` (String) The name of the Kinesis Data Firehose delivery stream where the data is written. - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--firehose--payload)) - `separator` (String) 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). ### Nested Schema for `alarm_event_actions.alarm_actions.firehose.separator` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.iot_events` Optional: - `input_name` (String) The name of the AWS IoT Events input where the data is sent. - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_events--payload)) ### Nested Schema for `alarm_event_actions.alarm_actions.iot_events.payload` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.iot_site_wise` Optional: - `asset_id` (String) The ID of the asset that has the specified property. You can specify an expression. - `entry_id` (String) 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. - `property_alias` (String) The alias of the asset property. You can also specify an expression. - `property_id` (String) The ID of the asset property. You can specify an expression. - `property_value` (Attributes) A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_site_wise--property_value)) ### Nested Schema for `alarm_event_actions.alarm_actions.iot_site_wise.property_value` Optional: - `quality` (String) The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression. - `timestamp` (Attributes) A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_site_wise--property_value--timestamp)) - `value` (Attributes) A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference*. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_site_wise--property_value--value)) ### Nested Schema for `alarm_event_actions.alarm_actions.iot_site_wise.property_value.timestamp` Optional: - `offset_in_nanos` (String) The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression. - `time_in_seconds` (String) The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression. ### Nested Schema for `alarm_event_actions.alarm_actions.iot_site_wise.property_value.value` Optional: - `boolean_value` (String) 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. - `double_value` (String) 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. - `integer_value` (String) 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. - `string_value` (String) 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. ### Nested Schema for `alarm_event_actions.alarm_actions.iot_topic_publish` Optional: - `mqtt_topic` (String) The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string. - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--iot_topic_publish--payload)) ### Nested Schema for `alarm_event_actions.alarm_actions.iot_topic_publish.payload` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.lambda` Optional: - `function_arn` (String) The ARN of the Lambda function that is executed. - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--lambda--payload)) ### Nested Schema for `alarm_event_actions.alarm_actions.lambda.payload` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.sns` Optional: - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--sns--payload)) - `target_arn` (String) The ARN of the Amazon SNS target where the message is sent. ### Nested Schema for `alarm_event_actions.alarm_actions.sns.target_arn` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `alarm_event_actions.alarm_actions.sqs` Optional: - `payload` (Attributes) 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. (see [below for nested schema](#nestedatt--alarm_event_actions--alarm_actions--sqs--payload)) - `queue_url` (String) The URL of the SQS queue where the data is written. - `use_base_64` (Boolean) 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`. ### Nested Schema for `alarm_event_actions.alarm_actions.sqs.use_base_64` Optional: - `content_expression` (String) The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. - `type` (String) The value of the payload type can be either `STRING` or `JSON`. ### Nested Schema for `tags` Optional: - `key` (String) Key of the Tag. - `value` (String) Value of the Tag. ## Import Import is supported using the following syntax: ```shell $ terraform import awscc_iotevents_alarm_model.example ```