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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_name ⇒ String

The name of the alarm.

Returns:

  • (String) 


6128
6129
6130
6131
6132
6133
6134
6135
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 6128

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

#state_reason ⇒ String

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

Returns:

  • (String) 


6128
6129
6130
6131
6132
6133
6134
6135
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 6128

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

#state_reason_data ⇒ String

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) 


6128
6129
6130
6131
6132
6133
6134
6135
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 6128

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

#state_value ⇒ String

The value of the state.

Returns:

  • (String) 


6128
6129
6130
6131
6132
6133
6134
6135
 
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 6128

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