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

Inherits:

Struct

Object
Struct
Aws::CloudWatch::Types::MetricAlarm

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudwatch/types.rb

Overview

The details about a metric alarm.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#actions_enabled ⇒ Boolean

Indicates whether actions should be executed during any changes to the alarm state.
#alarm_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the ‘ALARM` state from any other state.
#alarm_arn ⇒ String

The Amazon Resource Name (ARN) of the alarm.
#alarm_configuration_updated_timestamp ⇒ Time

The time stamp of the last update to the alarm configuration.
#alarm_description ⇒ String

The description of the alarm.
#alarm_name ⇒ String

The name of the alarm.
#comparison_operator ⇒ String

The arithmetic operation to use when comparing the specified statistic and threshold.
#datapoints_to_alarm ⇒ Integer

The number of data points that must be breaching to trigger the alarm.
#dimensions ⇒ Array<Types::Dimension>

The dimensions for the metric associated with the alarm.
#evaluate_low_sample_count_percentile ⇒ String

Used only for alarms based on percentiles.
#evaluation_periods ⇒ Integer

The number of periods over which data is compared to the specified threshold.
#evaluation_state ⇒ String

If the value of this field is ‘PARTIAL_DATA`, the alarm is being evaluated based on only partial data.
#extended_statistic ⇒ String

The percentile statistic for the metric associated with the alarm.
#insufficient_data_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the ‘INSUFFICIENT_DATA` state from any other state.
#metric_name ⇒ String

The name of the metric associated with the alarm, if this is an alarm based on a single metric.
#metrics ⇒ Array<Types::MetricDataQuery>

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

The namespace of the metric associated with the alarm.
#ok_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the ‘OK` state from any other state.
#period ⇒ Integer

The period, in seconds, over which the statistic is applied.
#state_reason ⇒ String

An explanation for the alarm state, in text format.
#state_reason_data ⇒ String

An explanation for the alarm state, in JSON format.
#state_transitioned_timestamp ⇒ Time

The date and time that the alarm’s ‘StateValue` most recently changed.
#state_updated_timestamp ⇒ Time

The time stamp of the last update to the value of either the ‘StateValue` or `EvaluationState` parameters.
#state_value ⇒ String

The state value for the alarm.
#statistic ⇒ String

The statistic for the metric associated with the alarm, other than percentile.
#threshold ⇒ Float

The value to compare with the specified statistic.
#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.
#treat_missing_data ⇒ String

Sets how this alarm is to handle missing data points.
#unit ⇒ String

The unit of the metric associated with the alarm.

Instance Attribute Details

#actions_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_actions ⇒ `Array<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>)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_arn ⇒ `String`

The Amazon Resource Name (ARN) of the alarm.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_configuration_updated_timestamp ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_description ⇒ `String`

The description of the alarm.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_name ⇒ `String`

The name of the alarm.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#comparison_operator ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#datapoints_to_alarm ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ `Array<Types::Dimension>`

The dimensions for the metric associated with the alarm.

Returns:

(Array<Types::Dimension>)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#evaluate_low_sample_count_percentile ⇒ `String`

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)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_periods ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_state ⇒ `String`

If the value of this field is ‘PARTIAL_DATA`, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see [Create alarms on Metrics Insights queries].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#extended_statistic ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#insufficient_data_actions ⇒ `Array<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>)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ `Array<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 ‘ReturnData` set to true.

Returns:

(Array<Types::MetricDataQuery>)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ `String`

The namespace of the metric associated with the alarm.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#ok_actions ⇒ `Array<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>)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ `String`

An explanation for the alarm state, in text format.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason_data ⇒ `String`

An explanation for the alarm state, in JSON format.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#state_transitioned_timestamp ⇒ `Time`

The date and time that the alarm’s ‘StateValue` most recently changed.

Returns:

(Time)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#state_updated_timestamp ⇒ `Time`

The time stamp of the last update to the value of either the ‘StateValue` or `EvaluationState` parameters.

Returns:

(Time)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#state_value ⇒ `String`

The state value for the alarm.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#statistic ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#threshold ⇒ `Float`

The value to compare with the specified statistic.

Returns:

(Float)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#treat_missing_data ⇒ `String`

Sets how this alarm is to handle missing data points. The valid values are ‘breaching`, `notBreaching`, `ignore`, and `missing`. For more information, see [Configuring how CloudWatch alarms treat missing data].

If this parameter is omitted, the default behavior of ‘missing` is used.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ `String`

The unit of the metric associated with the alarm.

Returns:

(String)

# File 'lib/aws-sdk-cloudwatch/types.rb', line 2558

class MetricAlarm < Struct.new(
  :alarm_name,
  :alarm_arn,
  :alarm_description,
  :alarm_configuration_updated_timestamp,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :state_value,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :metric_name,
  :namespace,
  :statistic,
  :extended_statistic,
  :dimensions,
  :period,
  :unit,
  :evaluation_periods,
  :datapoints_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :evaluate_low_sample_count_percentile,
  :metrics,
  :threshold_metric_id,
  :evaluation_state,
  :state_transitioned_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabled ⇒ Boolean

#alarm_actions ⇒ Array<String>

#alarm_arn ⇒ String

#alarm_configuration_updated_timestamp ⇒ Time

#alarm_description ⇒ String

#alarm_name ⇒ String

#comparison_operator ⇒ String

#datapoints_to_alarm ⇒ Integer

#dimensions ⇒ Array<Types::Dimension>

#evaluate_low_sample_count_percentile ⇒ String

#evaluation_periods ⇒ Integer

#evaluation_state ⇒ String

#extended_statistic ⇒ String

#insufficient_data_actions ⇒ Array<String>

#metric_name ⇒ String

#metrics ⇒ Array<Types::MetricDataQuery>

#namespace ⇒ String

#ok_actions ⇒ Array<String>

#period ⇒ Integer

#state_reason ⇒ String

#state_reason_data ⇒ String

#state_transitioned_timestamp ⇒ Time

#state_updated_timestamp ⇒ Time

#state_value ⇒ String

#statistic ⇒ String

#threshold ⇒ Float

#threshold_metric_id ⇒ String

#treat_missing_data ⇒ String

#unit ⇒ String

#actions_enabled ⇒ `Boolean`

#alarm_actions ⇒ `Array<String>`

#alarm_arn ⇒ `String`

#alarm_configuration_updated_timestamp ⇒ `Time`

#alarm_description ⇒ `String`

#alarm_name ⇒ `String`

#comparison_operator ⇒ `String`

#datapoints_to_alarm ⇒ `Integer`

#dimensions ⇒ `Array<Types::Dimension>`

#evaluate_low_sample_count_percentile ⇒ `String`

#evaluation_periods ⇒ `Integer`

#evaluation_state ⇒ `String`

#extended_statistic ⇒ `String`

#insufficient_data_actions ⇒ `Array<String>`

#metric_name ⇒ `String`

#metrics ⇒ `Array<Types::MetricDataQuery>`

#namespace ⇒ `String`

#ok_actions ⇒ `Array<String>`

#period ⇒ `Integer`

#state_reason ⇒ `String`

#state_reason_data ⇒ `String`

#state_transitioned_timestamp ⇒ `Time`

#state_updated_timestamp ⇒ `Time`

#state_value ⇒ `String`

#statistic ⇒ `String`

#threshold ⇒ `Float`

#threshold_metric_id ⇒ `String`

#treat_missing_data ⇒ `String`

#unit ⇒ `String`