You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ElasticLoadBalancing::Types::HealthCheck
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticLoadBalancing::Types::HealthCheck
- Defined in:
- (unknown)
Overview
When passing HealthCheck as input to an Aws::Client method, you can use a vanilla Hash:
{
target: "HealthCheckTarget", # required
interval: 1, # required
timeout: 1, # required
unhealthy_threshold: 1, # required
healthy_threshold: 1, # required
}
Information about a health check.
Returned by:
Instance Attribute Summary collapse
-
#healthy_threshold ⇒ Integer
The number of consecutive health checks successes required before moving the instance to the
Healthy
state. -
#interval ⇒ Integer
The approximate interval, in seconds, between health checks of an individual instance.
-
#target ⇒ String
The instance being checked.
-
#timeout ⇒ Integer
The amount of time, in seconds, during which no response means a failed health check.
-
#unhealthy_threshold ⇒ Integer
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.
Instance Attribute Details
#healthy_threshold ⇒ Integer
The number of consecutive health checks successes required before moving
the instance to the Healthy
state.
#interval ⇒ Integer
The approximate interval, in seconds, between health checks of an individual instance.
#target ⇒ String
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle%22. In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
#timeout ⇒ Integer
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
#unhealthy_threshold ⇒ Integer
The number of consecutive health check failures required before moving
the instance to the Unhealthy
state.