You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::TestAlarmRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::TestAlarmRequest
- Defined in:
- (unknown)
Overview
Note:
When passing TestAlarmRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
alarm_name: "ResourceName", # required
state: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
}
Instance Attribute Summary collapse
-
#alarm_name ⇒ String
The name of the alarm to test.
-
#state ⇒ String
The alarm state to test.
Instance Attribute Details
#alarm_name ⇒ String
The name of the alarm to test.
#state ⇒ String
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.Possible values:
- OK
- ALARM
- INSUFFICIENT_DATA