You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatch::Types::CompositeAlarm

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The details about a composite alarm.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabled ⇒ Boolean

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

Returns:

  • (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. Each action is specified as an Amazon Resource Name (ARN).

Returns:

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

Returns:

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

Returns:

  • (Time) —

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

#alarm_description ⇒ String

The description of the alarm.

Returns:

  • (String) —

    The description of the alarm.

#alarm_name ⇒ String

The name of the alarm.

Returns:

  • (String) —

    The name of the alarm.

#alarm_rule ⇒ String

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

Returns:

  • (String) —

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

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

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

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

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

#state_reason ⇒ String

An explanation for the alarm state, in text format.

Returns:

  • (String) —

    An explanation for the alarm state, in text format.

#state_reason_data ⇒ String

An explanation for the alarm state, in JSON format.

Returns:

  • (String) —

    An explanation for the alarm state, in JSON format.

#state_updated_timestamp ⇒ Time

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

Returns:

  • (Time) —

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

#state_value ⇒ String

The state value for the alarm.

Possible values:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

Returns:

  • (String) —

    The state value for the alarm.