@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class HealthCheck extends Object implements Serializable, Cloneable
Information about a health check.
Constructor and Description |
---|
HealthCheck()
Default constructor for HealthCheck object.
|
HealthCheck(String target,
Integer interval,
Integer timeout,
Integer unhealthyThreshold,
Integer healthyThreshold)
Constructs a new HealthCheck object.
|
Modifier and Type | Method and Description |
---|---|
HealthCheck |
clone() |
boolean |
equals(Object obj) |
Integer |
getHealthyThreshold()
The number of consecutive health checks successes required before moving the instance to the
Healthy
state. |
Integer |
getInterval()
The approximate interval, in seconds, between health checks of an individual instance.
|
String |
getTarget()
The instance being checked.
|
Integer |
getTimeout()
The amount of time, in seconds, during which no response means a failed health check.
|
Integer |
getUnhealthyThreshold()
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state. |
int |
hashCode() |
void |
setHealthyThreshold(Integer healthyThreshold)
The number of consecutive health checks successes required before moving the instance to the
Healthy
state. |
void |
setInterval(Integer interval)
The approximate interval, in seconds, between health checks of an individual instance.
|
void |
setTarget(String target)
The instance being checked.
|
void |
setTimeout(Integer timeout)
The amount of time, in seconds, during which no response means a failed health check.
|
void |
setUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state. |
String |
toString()
Returns a string representation of this object.
|
HealthCheck |
withHealthyThreshold(Integer healthyThreshold)
The number of consecutive health checks successes required before moving the instance to the
Healthy
state. |
HealthCheck |
withInterval(Integer interval)
The approximate interval, in seconds, between health checks of an individual instance.
|
HealthCheck |
withTarget(String target)
The instance being checked.
|
HealthCheck |
withTimeout(Integer timeout)
The amount of time, in seconds, during which no response means a failed health check.
|
HealthCheck |
withUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state. |
public HealthCheck()
public HealthCheck(String target, Integer interval, Integer timeout, Integer unhealthyThreshold, Integer healthyThreshold)
target
- 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". 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.
interval
- The approximate interval, in seconds, between health checks of an individual instance.timeout
- The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
unhealthyThreshold
- The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.healthyThreshold
- The number of consecutive health checks successes required before moving the instance to the
Healthy
state.public void setTarget(String target)
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". 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.
target
- 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". 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.
public String getTarget()
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". 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.
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". 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.
public HealthCheck withTarget(String target)
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". 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.
target
- 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". 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.
public void setInterval(Integer interval)
The approximate interval, in seconds, between health checks of an individual instance.
interval
- The approximate interval, in seconds, between health checks of an individual instance.public Integer getInterval()
The approximate interval, in seconds, between health checks of an individual instance.
public HealthCheck withInterval(Integer interval)
The approximate interval, in seconds, between health checks of an individual instance.
interval
- The approximate interval, in seconds, between health checks of an individual instance.public void setTimeout(Integer timeout)
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
timeout
- The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
public Integer getTimeout()
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
This value must be less than the Interval
value.
public HealthCheck withTimeout(Integer timeout)
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
timeout
- The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
public void setUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive health check failures required before moving the instance to the Unhealthy
state.
unhealthyThreshold
- The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.public Integer getUnhealthyThreshold()
The number of consecutive health check failures required before moving the instance to the Unhealthy
state.
Unhealthy
state.public HealthCheck withUnhealthyThreshold(Integer unhealthyThreshold)
The number of consecutive health check failures required before moving the instance to the Unhealthy
state.
unhealthyThreshold
- The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.public void setHealthyThreshold(Integer healthyThreshold)
The number of consecutive health checks successes required before moving the instance to the Healthy
state.
healthyThreshold
- The number of consecutive health checks successes required before moving the instance to the
Healthy
state.public Integer getHealthyThreshold()
The number of consecutive health checks successes required before moving the instance to the Healthy
state.
Healthy
state.public HealthCheck withHealthyThreshold(Integer healthyThreshold)
The number of consecutive health checks successes required before moving the instance to the Healthy
state.
healthyThreshold
- The number of consecutive health checks successes required before moving the instance to the
Healthy
state.public String toString()
toString
in class Object
Object.toString()
public HealthCheck clone()