Class: Aws::CloudWatch::Types::SetAlarmStateInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatch/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name of the alarm.

Returns:

  • (String)


5136
5137
5138
5139
5140
5141
5142
5143
# File 'lib/aws-sdk-cloudwatch/types.rb', line 5136

class SetAlarmStateInput < Struct.new(
  :alarm_name,
  :state_value,
  :state_reason,
  :state_reason_data)
  SENSITIVE = []
  include Aws::Structure
end

#state_reasonString

The reason that this alarm is set to this specific state, in text format.

Returns:

  • (String)


5136
5137
5138
5139
5140
5141
5142
5143
# File 'lib/aws-sdk-cloudwatch/types.rb', line 5136

class SetAlarmStateInput < Struct.new(
  :alarm_name,
  :state_value,
  :state_reason,
  :state_reason_data)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason_dataString

The reason that this alarm is set to this specific state, in JSON format.

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

Returns:

  • (String)


5136
5137
5138
5139
5140
5141
5142
5143
# File 'lib/aws-sdk-cloudwatch/types.rb', line 5136

class SetAlarmStateInput < Struct.new(
  :alarm_name,
  :state_value,
  :state_reason,
  :state_reason_data)
  SENSITIVE = []
  include Aws::Structure
end

#state_valueString

The value of the state.

Returns:

  • (String)


5136
5137
5138
5139
5140
5141
5142
5143
# File 'lib/aws-sdk-cloudwatch/types.rb', line 5136

class SetAlarmStateInput < Struct.new(
  :alarm_name,
  :state_value,
  :state_reason,
  :state_reason_data)
  SENSITIVE = []
  include Aws::Structure
end