class Amazonite::CloudWatch::MetricAlarm

• Amazonite::CloudWatch::MetricAlarm
• Reference
• Object

Overview

The details about a metric alarm.

Included Modules

• JSON::Serializable

Defined in:

cloudwatch/metric_alarm.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(alarm_name : String | Nil = nil, alarm_arn : String | Nil = nil, alarm_description : String | Nil = nil, alarm_configuration_updated_timestamp : Time | Nil = nil, actions_enabled : Bool | Nil = nil, ok_actions : Array(String) | Nil = nil, alarm_actions : Array(String) | Nil = nil, insufficient_data_actions : Array(String) | Nil = nil, state_value : StateValue | Nil = nil, state_reason : String | Nil = nil, state_reason_data : String | Nil = nil, state_updated_timestamp : Time | Nil = nil, metric_name : String | Nil = nil, namespace : String | Nil = nil, statistic : Statistic | Nil = nil, extended_statistic : String | Nil = nil, dimensions : Array(Dimension) | Nil = nil, period : Int32 | Nil = nil, unit : StandardUnit | Nil = nil, evaluation_periods : Int32 | Nil = nil, datapoints_to_alarm : Int32 | Nil = nil, threshold : Float64 | Nil = nil, comparison_operator : ComparisonOperator | Nil = nil, treat_missing_data : String | Nil = nil, evaluate_low_sample_count_percentile : String | Nil = nil, metrics : Array(MetricDataQuery) | Nil = nil, threshold_metric_id : String | Nil = nil, evaluation_state : EvaluationState | Nil = nil, state_transitioned_timestamp : Time | Nil = nil, evaluation_window : EvaluationWindow | Nil = nil, warm_up_configuration : WarmUpConfiguration | Nil = nil, evaluation_criteria : EvaluationCriteria | Nil = nil, evaluation_interval : Int32 | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #actions_enabled : Bool | Nil

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

• #actions_enabled=(actions_enabled : Bool | Nil)

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

• #alarm_actions : Array(String) | Nil

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

• #alarm_actions=(alarm_actions : Array(String) | Nil)

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

• #alarm_arn : String | Nil

  The Amazon Resource Name (ARN) of the alarm.

• #alarm_arn=(alarm_arn : String | Nil)

  The Amazon Resource Name (ARN) of the alarm.

• #alarm_configuration_updated_timestamp : Time | Nil

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

• #alarm_configuration_updated_timestamp=(alarm_configuration_updated_timestamp : Time | Nil)

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

• #alarm_description : String | Nil

  The description of the alarm.

• #alarm_description=(alarm_description : String | Nil)

  The description of the alarm.

• #alarm_name : String | Nil

  The name of the alarm.

• #alarm_name=(alarm_name : String | Nil)

  The name of the alarm.

• #comparison_operator : ComparisonOperator | Nil

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

• #comparison_operator=(comparison_operator : ComparisonOperator | Nil)

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

• #datapoints_to_alarm : Int32 | Nil

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

• #datapoints_to_alarm=(datapoints_to_alarm : Int32 | Nil)

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

• #dimensions : Array(Dimension) | Nil

  The dimensions for the metric associated with the alarm.

• #dimensions=(dimensions : Array(Dimension) | Nil)

  The dimensions for the metric associated with the alarm.

• #evaluate_low_sample_count_percentile : String | Nil

  Used only for alarms based on percentiles.

• #evaluate_low_sample_count_percentile=(evaluate_low_sample_count_percentile : String | Nil)

  Used only for alarms based on percentiles.

• #evaluation_criteria : EvaluationCriteria | Nil

  The evaluation criteria for the alarm.

• #evaluation_criteria=(evaluation_criteria : EvaluationCriteria | Nil)

  The evaluation criteria for the alarm.

• #evaluation_interval : Int32 | Nil

  The frequency, in seconds, at which the alarm is evaluated.

• #evaluation_interval=(evaluation_interval : Int32 | Nil)

  The frequency, in seconds, at which the alarm is evaluated.

• #evaluation_periods : Int32 | Nil

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

• #evaluation_periods=(evaluation_periods : Int32 | Nil)

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

• #evaluation_state : EvaluationState | Nil

  If the value of this field is PARTIAL_DATA, it indicates that not all the available data was able to be retrieved due to quota limitations.

• #evaluation_state=(evaluation_state : EvaluationState | Nil)

  If the value of this field is PARTIAL_DATA, it indicates that not all the available data was able to be retrieved due to quota limitations.

• #evaluation_window : EvaluationWindow | Nil

  The evaluation window that the alarm uses to select the range of metric data that it evaluates.

• #evaluation_window=(evaluation_window : EvaluationWindow | Nil)

  The evaluation window that the alarm uses to select the range of metric data that it evaluates.

• #extended_statistic : String | Nil

  The percentile statistic for the metric associated with the alarm.

• #extended_statistic=(extended_statistic : String | Nil)

  The percentile statistic for the metric associated with the alarm.

• #hash(hasher)

  See Object#hash(hasher)

• #insufficient_data_actions : Array(String) | Nil

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

• #insufficient_data_actions=(insufficient_data_actions : Array(String) | Nil)

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

• #metric_name : String | Nil

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

• #metric_name=(metric_name : String | Nil)

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

• #metrics : Array(MetricDataQuery) | Nil

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

• #metrics=(metrics : Array(MetricDataQuery) | Nil)

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

• #namespace : String | Nil

  The namespace of the metric associated with the alarm.

• #namespace=(namespace : String | Nil)

  The namespace of the metric associated with the alarm.

• #ok_actions : Array(String) | Nil

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

• #ok_actions=(ok_actions : Array(String) | Nil)

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

• #period : Int32 | Nil

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

• #period=(period : Int32 | Nil)

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

• #state_reason : String | Nil

  An explanation for the alarm state, in text format.

• #state_reason=(state_reason : String | Nil)

  An explanation for the alarm state, in text format.

• #state_reason_data : String | Nil

  An explanation for the alarm state, in JSON format.

• #state_reason_data=(state_reason_data : String | Nil)

  An explanation for the alarm state, in JSON format.

• #state_transitioned_timestamp : Time | Nil

  The date and time that the alarm's StateValue most recently changed.

• #state_transitioned_timestamp=(state_transitioned_timestamp : Time | Nil)

  The date and time that the alarm's StateValue most recently changed.

• #state_updated_timestamp : Time | Nil

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

• #state_updated_timestamp=(state_updated_timestamp : Time | Nil)

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

• #state_value : StateValue | Nil

  The state value for the alarm.

• #state_value=(state_value : StateValue | Nil)

  The state value for the alarm.

• #statistic : Statistic | Nil

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

• #statistic=(statistic : Statistic | Nil)

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

• #threshold : Float64 | Nil

  The value to compare with the specified statistic.

• #threshold=(threshold : Float64 | Nil)

  The value to compare with the specified statistic.

• #threshold_metric_id : String | Nil

  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.

• #threshold_metric_id=(threshold_metric_id : String | Nil)

  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 | Nil

  Sets how this alarm is to handle missing data points.

• #treat_missing_data=(treat_missing_data : String | Nil)

  Sets how this alarm is to handle missing data points.

• #unit : StandardUnit | Nil

  The unit of the metric associated with the alarm.

• #unit=(unit : StandardUnit | Nil)

  The unit of the metric associated with the alarm.

• #validate! : Nil
• #warm_up_configuration : WarmUpConfiguration | Nil

  The warm-up configuration for the alarm.

• #warm_up_configuration=(warm_up_configuration : WarmUpConfiguration | Nil)

  The warm-up configuration for the alarm.

Constructor Detail

Instance Method Detail