You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatch::Types::MetricAlarm

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents an alarm.

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabledBoolean

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

  • (Boolean)

    Indicates whether actions should be executed during any changes to the alarm state.

#alarm_actionsArray<String>

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).

Returns:

  • (Array<String>)

    The actions to execute when this alarm transitions to the ALARM state from any other state.

#alarm_arnString

The Amazon Resource Name (ARN) of the alarm.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the alarm.

#alarm_configuration_updated_timestampTime

The time stamp of the last update to the alarm configuration.

Returns:

  • (Time)

    The time stamp of the last update to the alarm configuration.

#alarm_descriptionString

The description of the alarm.

Returns:

  • (String)

    The description of the alarm.

#alarm_nameString

The name of the alarm.

Returns:

  • (String)

    The name of the alarm.

#comparison_operatorString

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

Possible values:

  • GreaterThanOrEqualToThreshold
  • GreaterThanThreshold
  • LessThanThreshold
  • LessThanOrEqualToThreshold
  • LessThanLowerOrGreaterThanUpperThreshold
  • LessThanLowerThreshold
  • GreaterThanUpperThreshold

Returns:

  • (String)

    The arithmetic operation to use when comparing the specified statistic and threshold.

#datapoints_to_alarmInteger

The number of datapoints that must be breaching to trigger the alarm.

Returns:

  • (Integer)

    The number of datapoints that must be breaching to trigger the alarm.

#dimensionsArray<Types::Dimension>

The dimensions for the metric associated with the alarm.

Returns:

  • (Array<Types::Dimension>)

    The dimensions for the metric associated with the alarm.

#evaluate_low_sample_count_percentileString

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.

Returns:

  • (String)

    Used only for alarms based on percentiles.

#evaluation_periodsInteger

The number of periods over which data is compared to the specified threshold.

Returns:

  • (Integer)

    The number of periods over which data is compared to the specified threshold.

#extended_statisticString

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

Returns:

  • (String)

    The percentile statistic for the metric associated with the alarm.

#insufficient_data_actionsArray<String>

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).

Returns:

  • (Array<String>)

    The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

#metric_nameString

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

Returns:

  • (String)

    The name of the metric associated with the alarm, if this is an alarm based on a single metric.

#metricsArray<Types::MetricDataQuery>

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 ReturnValue set to true.

Returns:

  • (Array<Types::MetricDataQuery>)

    An array of MetricDataQuery structures, used in an alarm based on a metric math expression.

#namespaceString

The namespace of the metric associated with the alarm.

Returns:

  • (String)

    The namespace of the metric associated with the alarm.

#ok_actionsArray<String>

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).

Returns:

  • (Array<String>)

    The actions to execute when this alarm transitions to the OK state from any other state.

#periodInteger

The period, in seconds, over which the statistic is applied.

Returns:

  • (Integer)

    The period, in seconds, over which the statistic is applied.

#state_reasonString

An explanation for the alarm state, in text format.

Returns:

  • (String)

    An explanation for the alarm state, in text format.

#state_reason_dataString

An explanation for the alarm state, in JSON format.

Returns:

  • (String)

    An explanation for the alarm state, in JSON format.

#state_updated_timestampTime

The time stamp of the last update to the alarm state.

Returns:

  • (Time)

    The time stamp of the last update to the alarm state.

#state_valueString

The state value for the alarm.

Possible values:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

Returns:

  • (String)

    The state value for the alarm.

#statisticString

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

Possible values:

  • SampleCount
  • Average
  • Sum
  • Minimum
  • Maximum

Returns:

  • (String)

    The statistic for the metric associated with the alarm, other than percentile.

#thresholdFloat

The value to compare with the specified statistic.

Returns:

  • (Float)

    The value to compare with the specified statistic.

#threshold_metric_idString

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.

Returns:

  • (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.

#treat_missing_dataString

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

Returns:

  • (String)

    Sets how this alarm is to handle missing data points.

#unitString

The unit of the metric associated with the alarm.

Possible values:

  • Seconds
  • Microseconds
  • Milliseconds
  • Bytes
  • Kilobytes
  • Megabytes
  • Gigabytes
  • Terabytes
  • Bits
  • Kilobits
  • Megabits
  • Gigabits
  • Terabits
  • Percent
  • Count
  • Bytes/Second
  • Kilobytes/Second
  • Megabytes/Second
  • Gigabytes/Second
  • Terabytes/Second
  • Bits/Second
  • Kilobits/Second
  • Megabits/Second
  • Gigabits/Second
  • Terabits/Second
  • Count/Second
  • None

Returns:

  • (String)

    The unit of the metric associated with the alarm.