com.amazonaws.services.elasticloadbalancing.model

Class HealthCheck

java.lang.Object

com.amazonaws.services.elasticloadbalancing.model.HealthCheck

All Implemented Interfaces:

Serializable, Cloneable

public class HealthCheck
extends Object
implements Serializable, Cloneable

Information about a health check.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HealthCheck() Default constructor for a new HealthCheck object.
HealthCheck(String target, Integer interval, Integer timeout, Integer unhealthyThreshold, Integer healthyThreshold) Constructs a new HealthCheck object.

Method Summary

Methods

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; useful for testing and debugging.
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.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HealthCheck

public HealthCheck()

Default constructor for a new HealthCheck object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

HealthCheck

public HealthCheck(String target,
           Integer interval,
           Integer timeout,
           Integer unhealthyThreshold,
           Integer healthyThreshold)

Constructs a new HealthCheck object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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.

Method Detail

getTarget

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.

Returns:

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.

setTarget

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.

Parameters:

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.

withTarget

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getInterval

public Integer getInterval()

The approximate interval, in seconds, between health checks of an individual instance.

Constraints:
Range: 1 - 300

Returns:

The approximate interval, in seconds, between health checks of an individual instance.

setInterval

public void setInterval(Integer interval)

The approximate interval, in seconds, between health checks of an individual instance.

Constraints:
Range: 1 - 300

Parameters:

interval - The approximate interval, in seconds, between health checks of an individual instance.

withInterval

public HealthCheck withInterval(Integer interval)

The approximate interval, in seconds, between health checks of an individual instance.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 300

Parameters:

interval - The approximate interval, in seconds, between health checks of an individual instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getTimeout

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.

Constraints:
Range: 1 - 300

Returns:

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

setTimeout

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.

Constraints:
Range: 1 - 300

Parameters:

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.

withTimeout

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 300

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getUnhealthyThreshold

public Integer getUnhealthyThreshold()

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

Constraints:
Range: 2 - 10

Returns:

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

setUnhealthyThreshold

public void setUnhealthyThreshold(Integer unhealthyThreshold)

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

Constraints:
Range: 2 - 10

Parameters:

unhealthyThreshold - The number of consecutive health check failures required before moving the instance to the Unhealthy state.

withUnhealthyThreshold

public HealthCheck withUnhealthyThreshold(Integer unhealthyThreshold)

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 2 - 10

Parameters:

unhealthyThreshold - The number of consecutive health check failures required before moving the instance to the Unhealthy state.

Returns:

A reference to this updated object so that method calls can be chained together.

getHealthyThreshold

public Integer getHealthyThreshold()

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Constraints:
Range: 2 - 10

Returns:

The number of consecutive health checks successes required before moving the instance to the Healthy state.

setHealthyThreshold

public void setHealthyThreshold(Integer healthyThreshold)

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Constraints:
Range: 2 - 10

Parameters:

healthyThreshold - The number of consecutive health checks successes required before moving the instance to the Healthy state.

withHealthyThreshold

public HealthCheck withHealthyThreshold(Integer healthyThreshold)

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 2 - 10

Parameters:

healthyThreshold - The number of consecutive health checks successes required before moving the instance to the Healthy state.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public HealthCheck clone()

Overrides:

clone in class Object