class Amazonite::CloudWatch::CompositeAlarm

• Amazonite::CloudWatch::CompositeAlarm
• Reference
• Object

Overview

The details about a composite alarm.

Included Modules

• JSON::Serializable

Defined in:

cloudwatch/composite_alarm.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(actions_enabled : Bool | Nil = nil, alarm_actions : Array(String) | Nil = nil, alarm_arn : String | Nil = nil, alarm_configuration_updated_timestamp : Time | Nil = nil, alarm_description : String | Nil = nil, alarm_name : String | Nil = nil, alarm_rule : String | Nil = nil, insufficient_data_actions : Array(String) | Nil = nil, ok_actions : Array(String) | Nil = nil, state_reason : String | Nil = nil, state_reason_data : String | Nil = nil, state_updated_timestamp : Time | Nil = nil, state_value : StateValue | Nil = nil, state_transitioned_timestamp : Time | Nil = nil, actions_suppressed_by : ActionsSuppressedBy | Nil = nil, actions_suppressed_reason : String | Nil = nil, actions_suppressor : String | Nil = nil, actions_suppressor_wait_period : Int32 | Nil = nil, actions_suppressor_extension_period : 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.

• #actions_suppressed_by : ActionsSuppressedBy | Nil

  When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state.

• #actions_suppressed_by=(actions_suppressed_by : ActionsSuppressedBy | Nil)

  When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state.

• #actions_suppressed_reason : String | Nil

  Captures the reason for action suppression.

• #actions_suppressed_reason=(actions_suppressed_reason : String | Nil)

  Captures the reason for action suppression.

• #actions_suppressor : String | Nil

  Actions will be suppressed if the suppressor alarm is in the ALARM state.

• #actions_suppressor=(actions_suppressor : String | Nil)

  Actions will be suppressed if the suppressor alarm is in the ALARM state.

• #actions_suppressor_extension_period : Int32 | Nil

  The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

• #actions_suppressor_extension_period=(actions_suppressor_extension_period : Int32 | Nil)

  The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

• #actions_suppressor_wait_period : Int32 | Nil

  The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.

• #actions_suppressor_wait_period=(actions_suppressor_wait_period : Int32 | Nil)

  The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into 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.

• #alarm_rule : String | Nil

  The rule that this alarm uses to evaluate its alarm state.

• #alarm_rule=(alarm_rule : String | Nil)

  The rule that this alarm uses to evaluate its alarm state.

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

• #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 timestamp of the last change to the alarm's StateValue.

• #state_transitioned_timestamp=(state_transitioned_timestamp : Time | Nil)

  The timestamp of the last change to the alarm's StateValue.

• #state_updated_timestamp : Time | Nil

  Tracks the timestamp of any state update, even if StateValue doesn't change.

• #state_updated_timestamp=(state_updated_timestamp : Time | Nil)

  Tracks the timestamp of any state update, even if StateValue doesn't change.

• #state_value : StateValue | Nil

  The state value for the alarm.

• #state_value=(state_value : StateValue | Nil)

  The state value for the alarm.

• #validate! : Nil

Constructor Detail

Instance Method Detail