Class: Aws::Lightsail::Types::TestAlarmRequest

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

Overview

Note:

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

{
  alarm_name: "ResourceName", # required
  state: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_nameString

The name of the alarm to test.

Returns:

  • (String)


11694
11695
11696
11697
11698
11699
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 11694

class TestAlarmRequest < Struct.new(
  :alarm_name,
  :state)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The alarm state to test.

An alarm has the following possible states that can be tested:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

Returns:

  • (String)


11694
11695
11696
11697
11698
11699
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 11694

class TestAlarmRequest < Struct.new(
  :alarm_name,
  :state)
  SENSITIVE = []
  include Aws::Structure
end