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",
}

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)

    The name for the alarm.

#state_reasonString

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_dataString

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

Returns:

  • (String)

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

#state_valueString

The value of the state.

Possible values:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

Returns:

  • (String)

    The value of the state.