com.amazonaws.services.elasticloadbalancing.model
Class HealthCheck

java.lang.Object
  com.amazonaws.services.elasticloadbalancing.model.HealthCheck

public class HealthCheck
extends Object

The HealthCheck data type.

Constructor Summary

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

boolean	equals(Object obj)
Integer	getHealthyThreshold() Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
Integer	getInterval() Specifies the approximate interval, in seconds, between health checks of an individual instance.
String	getTarget() Specifies the instance being checked.
Integer	getTimeout() Specifies the amount of time, in seconds, during which no response means a failed health probe.
Integer	getUnhealthyThreshold() Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.
int	hashCode()
void	setHealthyThreshold(Integer healthyThreshold) Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
void	setInterval(Integer interval) Specifies the approximate interval, in seconds, between health checks of an individual instance.
void	setTarget(String target) Specifies the instance being checked.
void	setTimeout(Integer timeout) Specifies the amount of time, in seconds, during which no response means a failed health probe.
void	setUnhealthyThreshold(Integer unhealthyThreshold) Specifies the number of consecutive health probe 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) Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
HealthCheck	withInterval(Integer interval) Specifies the approximate interval, in seconds, between health checks of an individual instance.
HealthCheck	withTarget(String target) Specifies the instance being checked.
HealthCheck	withTimeout(Integer timeout) Specifies the amount of time, in seconds, during which no response means a failed health probe.
HealthCheck	withUnhealthyThreshold(Integer unhealthyThreshold) Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

Methods inherited from class java.lang.Object

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 - Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to be 1024 16-bit Unicode characters or less.

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

timeout - Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the Interval value.

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

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

Method Detail

getTarget

public String getTarget()

Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to be 1024 16-bit Unicode characters or less.

Returns:

Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to be 1024 16-bit Unicode characters or less.

setTarget

public void setTarget(String target)

Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to be 1024 16-bit Unicode characters or less.

Parameters:

target - Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to be 1024 16-bit Unicode characters or less.

withTarget

public HealthCheck withTarget(String target)

Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to be 1024 16-bit Unicode characters or less.

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

Parameters:

target - Specifies 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 healthcheck 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 or HTTPS protocol, the situation is different. You have to 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 needs to 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()

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

Constraints:
Range: 1 - 300

Returns:

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

setInterval

public void setInterval(Integer interval)

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

Constraints:
Range: 1 - 300

Parameters:

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

withInterval

public HealthCheck withInterval(Integer interval)

Specifies 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 - Specifies 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()

Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the Interval value.

Constraints:
Range: 1 - 300

Returns:

Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the Interval value.

setTimeout

public void setTimeout(Integer timeout)

Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the Interval value.

Constraints:
Range: 1 - 300

Parameters:

timeout - Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the Interval value.

withTimeout

public HealthCheck withTimeout(Integer timeout)

Specifies the amount of time, in seconds, during which no response means a failed health probe. 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 - Specifies the amount of time, in seconds, during which no response means a failed health probe. 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()

Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

Constraints:
Range: 2 - 10

Returns:

Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

setUnhealthyThreshold

public void setUnhealthyThreshold(Integer unhealthyThreshold)

Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

Constraints:
Range: 2 - 10

Parameters:

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

withUnhealthyThreshold

public HealthCheck withUnhealthyThreshold(Integer unhealthyThreshold)

Specifies the number of consecutive health probe 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 - Specifies the number of consecutive health probe 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()

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

Constraints:
Range: 2 - 10

Returns:

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

setHealthyThreshold

public void setHealthyThreshold(Integer healthyThreshold)

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

Constraints:
Range: 2 - 10

Parameters:

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

withHealthyThreshold

public HealthCheck withHealthyThreshold(Integer healthyThreshold)

Specifies the number of consecutive health probe 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 - Specifies the number of consecutive health probe 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