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

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatch::Types::CompositeAlarm

Defined in:

gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

The details about a composite alarm.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

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

• #alarm_description ⇒ String

  The description of the alarm.

• #alarm_name ⇒ String

  The name of the alarm.

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

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

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

• #state_value ⇒ String

  The state value for the alarm.

Instance Attribute Details

#actions_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_arn ⇒ String

The Amazon Resource Name (ARN) of the alarm.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_configuration_updated_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_description ⇒ String

The description of the alarm.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_name ⇒ String

The name of the alarm.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_rule ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

An explanation for the alarm state, in text format.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason_data ⇒ String

An explanation for the alarm state, in JSON format.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_updated_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_value ⇒ String

The state value for the alarm.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end