alarm_models

Creates, updates, deletes or gets an alarm_model resource or lists alarm_models in a region

Overview

Name	alarm_models
Type	Resource
Description	Represents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*.
Id	awscc.iotevents.alarm_models

Fields

get (all properties)

Name	Datatype	Description
alarm_model_name	string	The name of the alarm model.
alarm_model_description	string	The description of the alarm model.
role_arn	string	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
key	string	An input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
severity	integer	A non-negative integer that reflects the severity level of the alarm.
▶alarm_rule	object	Defines when your alarm is invoked.
▶alarm_event_actions	object	Contains information about one or more alarm actions.
▶alarm_capabilities	object	Contains the configuration information of alarm state changes.
▶tags	array	A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see &#91;Tagging your resources&#93;(https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the &#42;Developer Guide&#42;.<br />You can create up to 50 tags for one alarm model.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
alarm_model_name	string	The name of the alarm model.
region	string	AWS region.

For more information, see AWS::IoTEvents::AlarmModel.

Methods

Name	Resource	Accessible by	Required Params
create_resource	alarm_models	INSERT	RoleArn, AlarmRule, region
delete_resource	alarm_models	DELETE	Identifier, region
update_resource	alarm_models	UPDATE	Identifier, PatchDocument, region
list_resources	alarm_models_list_only	SELECT	region
get_resource	alarm_models	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual alarm_model.

SELECT
  region,
  alarm_model_name,
  alarm_model_description,
  role_arn,
  key,
  severity,
  alarm_rule,
  alarm_event_actions,
  alarm_capabilities,
  tags
FROM awscc.iotevents.alarm_models
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ alarm_model_name }}';

list (identifiers only)

Lists all alarm_models in a region.

SELECT
  region,
  alarm_model_name
FROM awscc.iotevents.alarm_models_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new alarm_model resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.iotevents.alarm_models (
  RoleArn,
  AlarmRule,
  region
)
SELECT
  '{{ role_arn }}',
  '{{ alarm_rule }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iotevents.alarm_models (
  AlarmModelName,
  AlarmModelDescription,
  RoleArn,
  Key,
  Severity,
  AlarmRule,
  AlarmEventActions,
  AlarmCapabilities,
  Tags,
  region
)
SELECT
  '{{ alarm_model_name }}',
  '{{ alarm_model_description }}',
  '{{ role_arn }}',
  '{{ key }}',
  '{{ severity }}',
  '{{ alarm_rule }}',
  '{{ alarm_event_actions }}',
  '{{ alarm_capabilities }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: alarm_model
    props:
      - name: alarm_model_name
        value: '{{ alarm_model_name }}'
      - name: alarm_model_description
        value: '{{ alarm_model_description }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: key
        value: '{{ key }}'
      - name: severity
        value: '{{ severity }}'
      - name: alarm_rule
        value:
          simple_rule:
            input_property: '{{ input_property }}'
            comparison_operator: '{{ comparison_operator }}'
            threshold: '{{ threshold }}'
      - name: alarm_event_actions
        value:
          alarm_actions:
            - dynamo_db:
                hash_key_field: '{{ hash_key_field }}'
                hash_key_type: '{{ hash_key_type }}'
                hash_key_value: '{{ hash_key_value }}'
                operation: '{{ operation }}'
                payload:
                  content_expression: '{{ content_expression }}'
                  type: '{{ type }}'
                payload_field: '{{ payload_field }}'
                range_key_field: '{{ range_key_field }}'
                range_key_type: '{{ range_key_type }}'
                range_key_value: '{{ range_key_value }}'
                table_name: '{{ table_name }}'
              dynamo_dbv2:
                payload: null
                table_name: '{{ table_name }}'
              firehose:
                delivery_stream_name: '{{ delivery_stream_name }}'
                payload: null
                separator: '{{ separator }}'
              iot_events:
                input_name: '{{ input_name }}'
                payload: null
              iot_site_wise:
                asset_id: '{{ asset_id }}'
                entry_id: '{{ entry_id }}'
                property_alias: '{{ property_alias }}'
                property_id: '{{ property_id }}'
                property_value:
                  quality: '{{ quality }}'
                  timestamp:
                    offset_in_nanos: '{{ offset_in_nanos }}'
                    time_in_seconds: '{{ time_in_seconds }}'
                  value:
                    boolean_value: '{{ boolean_value }}'
                    double_value: '{{ double_value }}'
                    integer_value: '{{ integer_value }}'
                    string_value: '{{ string_value }}'
              iot_topic_publish:
                mqtt_topic: '{{ mqtt_topic }}'
                payload: null
              lambda:
                function_arn: '{{ function_arn }}'
                payload: null
              sns:
                payload: null
                target_arn: '{{ target_arn }}'
              sqs:
                payload: null
                queue_url: '{{ queue_url }}'
                use_base64: '{{ use_base64 }}'
      - name: alarm_capabilities
        value:
          initialization_configuration:
            disabled_on_initialization: '{{ disabled_on_initialization }}'
          acknowledge_flow:
            enabled: '{{ enabled }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a alarm_model resource, using stack-deploy.

/*+ update */
UPDATE awscc.iotevents.alarm_models
SET PatchDocument = string('{{ {
    "AlarmModelDescription": alarm_model_description,
    "RoleArn": role_arn,
    "Severity": severity,
    "AlarmRule": alarm_rule,
    "AlarmEventActions": alarm_event_actions,
    "AlarmCapabilities": alarm_capabilities,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alarm_model_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iotevents.alarm_models
WHERE
  Identifier = '{{ alarm_model_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

iotevents:CreateAlarmModel,
iotevents:UpdateInputRouting,
iotevents:DescribeAlarmModel,
iotevents:ListTagsForResource,
iotevents:TagResource,
iam:PassRole

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

List

iotevents:ListAlarmModels