class Aws::CloudWatch::Types::MetricAlarm

The details about a metric alarm.

@!attribute [rw] alarm_name

The name of the alarm.
@return [String]

@!attribute [rw] alarm_arn

The Amazon Resource Name (ARN) of the alarm.
@return [String]

@!attribute [rw] alarm_description

The description of the alarm.
@return [String]

@!attribute [rw] alarm_configuration_updated_timestamp

The time stamp of the last update to the alarm configuration.
@return [Time]

@!attribute [rw] actions_enabled

Indicates whether actions should be executed during any changes to
the alarm state.
@return [Boolean]

@!attribute [rw] ok_actions

The actions to execute when this alarm transitions to the `OK` state
from any other state. Each action is specified as an Amazon Resource
Name (ARN).
@return [Array<String>]

@!attribute [rw] alarm_actions

The actions to execute when this alarm transitions to the `ALARM`
state from any other state. Each action is specified as an Amazon
Resource Name (ARN).
@return [Array<String>]

@!attribute [rw] insufficient_data_actions

The actions to execute when this alarm transitions to the
`INSUFFICIENT_DATA` state from any other state. Each action is
specified as an Amazon Resource Name (ARN).
@return [Array<String>]

@!attribute [rw] state_value

The state value for the alarm.
@return [String]

@!attribute [rw] state_reason

An explanation for the alarm state, in text format.
@return [String]

@!attribute [rw] state_reason_data

An explanation for the alarm state, in JSON format.
@return [String]

@!attribute [rw] state_updated_timestamp

The time stamp of the last update to the alarm state.
@return [Time]

@!attribute [rw] metric_name

The name of the metric associated with the alarm, if this is an
alarm based on a single metric.
@return [String]

@!attribute [rw] namespace

The namespace of the metric associated with the alarm.
@return [String]

@!attribute [rw] statistic

The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use `ExtendedStatistic`.
@return [String]

@!attribute [rw] extended_statistic

The percentile statistic for the metric associated with the alarm.
Specify a value between p0.0 and p100.
@return [String]

@!attribute [rw] dimensions

The dimensions for the metric associated with the alarm.
@return [Array<Types::Dimension>]

@!attribute [rw] period

The period, in seconds, over which the statistic is applied.
@return [Integer]

@!attribute [rw] unit

The unit of the metric associated with the alarm.
@return [String]

@!attribute [rw] evaluation_periods

The number of periods over which data is compared to the specified
threshold.
@return [Integer]

@!attribute [rw] datapoints_to_alarm

The number of data points that must be breaching to trigger the
alarm.
@return [Integer]

@!attribute [rw] threshold

The value to compare with the specified statistic.
@return [Float]

@!attribute [rw] comparison_operator

The arithmetic operation to use when comparing the specified
statistic and threshold. The specified statistic value is used as
the first operand.
@return [String]

@!attribute [rw] treat_missing_data

Sets how this alarm is to handle missing data points. If this
parameter is omitted, the default behavior of `missing` is used.
@return [String]

@!attribute [rw] evaluate_low_sample_count_percentile

Used only for alarms based on percentiles. If `ignore`, the alarm
state does not change during periods with too few data points to be
statistically significant. If `evaluate` or this parameter is not
used, the alarm is always evaluated and possibly changes state no
matter how many data points are available.
@return [String]

@!attribute [rw] metrics

An array of MetricDataQuery structures, used in an alarm based on a
metric math expression. Each structure either retrieves a metric or
performs a math expression. One item in the Metrics array is the
math expression that the alarm watches. This expression by
designated by having `ReturnData` set to true.
@return [Array<Types::MetricDataQuery>]

@!attribute [rw] threshold_metric_id

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm AWS API Documentation

Constants

SENSITIVE