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

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

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

Overview

Note:

When passing SetAlarmStateInput as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_name ⇒ String

The name of the alarm.

Returns:

  • (String) —

    The name of the alarm.

#state_reason ⇒ String

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

Returns:

  • (String) —

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

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

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

#state_value ⇒ String

The value of the state.

Possible values:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

Returns:

  • (String) —

    The value of the state.