AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTEvents::AlarmModel

CfnAlarmModel

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](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *AWS IoT Events Developer Guide* .

Import

import { CfnAlarmModel } from 'aws-cdk-lib/aws-iotevents';

Or use the module namespace:

import * as iotevents from 'aws-cdk-lib/aws-iotevents';
// iotevents.CfnAlarmModel

Properties

Configuration passed to the constructor as CfnAlarmModelProps.

alarmRuleRequired
IResolvable | AlarmRuleProperty

Defines when your alarm is invoked.

roleArnRequired
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 *AWS General Reference* .

alarmCapabilitiesOptional
IResolvable | AlarmCapabilitiesProperty

Contains the configuration information of alarm state changes.

alarmEventActionsOptional
IResolvable | AlarmEventActionsProperty

Contains information about one or more alarm actions.

alarmModelDescriptionOptional
string

The description of the alarm model.

alarmModelNameOptional
string

The name of the alarm model.

keyOptional
string

An input attribute used as a key to create an alarm. AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.

severityOptional
number

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

tagsOptional
CfnTag[]

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](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *AWS IoT Events Developer Guide* . You can create up to 50 tags for one alarm model.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoTEvents::AlarmModelView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iotevents
CFN TypeAWS::IoTEvents::AlarmModel
Properties9

Related Constructs

Explore This Service

External Links