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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

The details about a metric alarm.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabledBoolean

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

Returns:

  • (Boolean)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_arnString

The Amazon Resource Name (ARN) of the alarm.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_configuration_updated_timestampTime

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

Returns:

  • (Time)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_descriptionString

The description of the alarm.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_nameString

The name of the alarm.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#comparison_operatorString

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

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#datapoints_to_alarmInteger

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

Returns:

  • (Integer)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#dimensionsArray<Types::Dimension>

The dimensions for the metric associated with the alarm.

Returns:



2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_periodsInteger

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

Returns:

  • (Integer)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#extended_statisticString

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

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#metric_nameString

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

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:



2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

The namespace of the metric associated with the alarm.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#periodInteger

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

Returns:

  • (Integer)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#state_reasonString

An explanation for the alarm state, in text format.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason_dataString

An explanation for the alarm state, in JSON format.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#state_updated_timestampTime

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

Returns:

  • (Time)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#state_valueString

The state value for the alarm.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#statisticString

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

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#thresholdFloat

The value to compare with the specified statistic.

Returns:

  • (Float)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

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


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end

#unitString

The unit of the metric associated with the alarm.

Returns:

  • (String)


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2623

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)
  SENSITIVE = []
  include Aws::Structure
end