alarm_model

Gets an individual alarm_model resource

Overview

Name	alarm_model
Type	Resource
Description	alarm_model
Id	awscc.iotevents.alarm_model

Fields

Name	Datatype	Description
alarm_model_name	string	The name of the alarm model.
alarm_model_description	string	A brief description of the alarm model.
role_arn	string	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
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.<br/><br/>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	integer	A non-negative integer that reflects the severity level of the alarm.<br/><br/>
alarm_rule	object
alarm_event_actions	object
alarm_capabilities	object
tags	array	An array of key-value pairs to apply to this resource.<br/><br/>For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
alarm_model_name,
alarm_model_description,
role_arn,
key,
severity,
alarm_rule,
alarm_event_actions,
alarm_capabilities,
tags
FROM awscc.iotevents.alarm_model
WHERE data__Identifier = '<AlarmModelName>';

Permissions

To operate on the alarm_model resource, the following permissions are required:

Read

iotevents:DescribeAlarmModel,
iotevents:ListTagsForResource

Update

iotevents:UpdateAlarmModel,
iotevents:UpdateInputRouting,
iotevents:DescribeAlarmModel,
iotevents:ListTagsForResource,
iotevents:UntagResource,
iotevents:TagResource,
iam:PassRole

Delete

iotevents:DeleteAlarmModel,
iotevents:DescribeAlarmModel