AWS::IoTEvents::AlarmModel

Represents an alarm model to monitor an AWS IoT Events 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 in the AWS IoT Events Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTEvents::AlarmModel",
  "Properties" : {
      "AlarmCapabilities" : AlarmCapabilities,
      "AlarmEventActions" : AlarmEventActions,
      "AlarmModelDescription" : String,
      "AlarmModelName" : String,
      "AlarmRule" : AlarmRule,
      "Key" : String,
      "RoleArn" : String,
      "Severity" : Integer,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTEvents::AlarmModel
Properties:
  AlarmCapabilities: 
    AlarmCapabilities
  AlarmEventActions: 
    AlarmEventActions
  AlarmModelDescription: String
  AlarmModelName: String
  AlarmRule: 
    AlarmRule
  Key: String
  RoleArn: String
  Severity: Integer
  Tags: 
    - Tag

Properties

AlarmCapabilities

Contains the configuration information of alarm state changes.

Required: No

Type: AlarmCapabilities

Update requires: No interruption

AlarmEventActions

Contains information about one or more alarm actions.

Required: No

Type: AlarmEventActions

Update requires: No interruption

AlarmModelDescription

The description of the alarm model.

Required: No

Type: String

Maximum: 1024

Update requires: No interruption

AlarmModelName

The name of the alarm model.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

AlarmRule

Defines when your alarm is invoked.

Required: Yes

Type: AlarmRule

Update requires: No interruption

Key

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

Required: No

Type: String

Pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$

Minimum: 1

Maximum: 128

Update requires: Replacement

RoleArn

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) in the AWS General Reference.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Severity

A non-negative integer that reflects the severity level of the alarm.

Required: No

Type: Integer

Minimum: 0

Maximum: 2147483647

Update requires: No interruption

Tags

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

You can create up to 50 tags for one alarm model.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the alarm model. For example:

{"Ref": "myAlarmModel"}

For the AWS IoT Events alarm model myAlarmModel, Ref returns the name of the alarm model.

For more information about using the Ref function, see Ref.