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

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

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

Overview

Note:

When making an API call, you may pass SetAlarmStateInput data as a hash:

{
  alarm_name: "AlarmName", # required
  state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
  state_reason: "StateReason", # required
  state_reason_data: "StateReasonData",
}

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

Returns:

  • (String)


1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1393

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

#state_reasonString

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

Returns:

  • (String)


1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1393

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

#state_reason_dataString

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

Returns:

  • (String)


1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1393

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

#state_valueString

The value of the state.

Returns:

  • (String)


1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1393

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