alarm

Gets an individual alarm resource

Overview

Name	alarm
Type	Resource
Description	alarm
Id	awscc.cloudwatch.alarm

Fields

Name	Datatype	Description
threshold_metric_id	string	In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
evaluate_low_sample_count_percentile	string	Used only for alarms based on percentiles.
extended_statistic	string	The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
comparison_operator	string	The arithmetic operation to use when comparing the specified statistic and threshold.
treat_missing_data	string	Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
dimensions	array	The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
period	integer	The period in seconds, over which the statistic is applied.
evaluation_periods	integer	The number of periods over which data is compared to the specified threshold.
unit	string	The unit of the metric associated with the alarm.
namespace	string	The namespace of the metric associated with the alarm.
ok_actions	array	The actions to execute when this alarm transitions to the OK state from any other state.
alarm_actions	array	The list of actions to execute when this alarm transitions into an ALARM state from any other state.
metric_name	string	The name of the metric associated with the alarm.
actions_enabled	boolean	Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
metrics	array	An array that enables you to create an alarm based on the result of a metric math expression.
alarm_description	string	The description of the alarm.
alarm_name	string	The name of the alarm.
statistic	string	The statistic for the metric associated with the alarm, other than percentile.
insufficient_data_actions	array	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
arn	string	Amazon Resource Name is a unique name for each resource.
datapoints_to_alarm	integer	The number of datapoints that must be breaching to trigger the alarm.
threshold	number	In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
threshold_metric_id,
evaluate_low_sample_count_percentile,
extended_statistic,
comparison_operator,
treat_missing_data,
dimensions,
period,
evaluation_periods,
unit,
namespace,
ok_actions,
alarm_actions,
metric_name,
actions_enabled,
metrics,
alarm_description,
alarm_name,
statistic,
insufficient_data_actions,
arn,
datapoints_to_alarm,
threshold
FROM awscc.cloudwatch.alarm
WHERE data__Identifier = '<AlarmName>';

Permissions

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

Update

cloudwatch:PutMetricAlarm,
cloudwatch:DescribeAlarms

Delete

cloudwatch:DeleteAlarms,
cloudwatch:DescribeAlarms

Read

cloudwatch:DescribeAlarms