class Amazonite::CloudWatch::LogAlarm

• Amazonite::CloudWatch::LogAlarm
• Reference
• Object

Overview

The details about a log alarm.

Included Modules

• JSON::Serializable

Defined in:

cloudwatch/log_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, scheduled_query_configuration : ScheduledQueryConfiguration | Nil = nil, query_results_to_evaluate : Int32 | Nil = nil, query_results_to_alarm : Int32 | Nil = nil, threshold : Float64 | Nil = nil, comparison_operator : ComparisonOperator | Nil = nil, treat_missing_data : String | Nil = nil, state_transitioned_timestamp : Time | Nil = nil, evaluation_state : EvaluationState | Nil = nil, action_log_line_count : Int32 | Nil = nil, action_log_line_role_arn : String | Nil = nil, warm_up_configuration : WarmUpConfiguration | 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.

• #action_log_line_count : Int32 | Nil

  The number of log lines from the most recent scheduled query execution that are included in alarm action notifications.

• #action_log_line_count=(action_log_line_count : Int32 | Nil)

  The number of log lines from the most recent scheduled query execution that are included in alarm action notifications.

• #action_log_line_role_arn : String | Nil

  The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications.

• #action_log_line_role_arn=(action_log_line_role_arn : String | Nil)

  The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications.

• #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 aggregated query result and the threshold.

• #comparison_operator=(comparison_operator : ComparisonOperator | Nil)

  The arithmetic operation to use when comparing the aggregated query result and the threshold.

• #evaluation_state : EvaluationState | Nil

  If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction.

• #evaluation_state=(evaluation_state : EvaluationState | Nil)

  If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction.

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

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

• #query_results_to_alarm : Int32 | Nil

  The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

• #query_results_to_alarm=(query_results_to_alarm : Int32 | Nil)

  The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

• #query_results_to_evaluate : Int32 | Nil

  The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

• #query_results_to_evaluate=(query_results_to_evaluate : Int32 | Nil)

  The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

• #scheduled_query_configuration : ScheduledQueryConfiguration | Nil

  The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

• #scheduled_query_configuration=(scheduled_query_configuration : ScheduledQueryConfiguration | Nil)

  The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

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

• #threshold : Float64 | Nil

  The value to compare with the aggregated query result.

• #threshold=(threshold : Float64 | Nil)

  The value to compare with the aggregated query result.

• #treat_missing_data : String | Nil

  How this alarm handles missing data points.

• #treat_missing_data=(treat_missing_data : String | Nil)

  How this alarm handles missing data points.

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