public class HealthCheckConfig extends Object implements Serializable, Cloneable
A complex type that contains the health check configuration.
| Constructor and Description |
|---|
HealthCheckConfig() |
| Modifier and Type | Method and Description |
|---|---|
HealthCheckConfig |
clone() |
boolean |
equals(Object obj) |
List<String> |
getChildHealthChecks()
For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks. |
Integer |
getFailureThreshold()
The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa.
|
String |
getFullyQualifiedDomainName()
Fully qualified domain name of the instance to be health checked.
|
Integer |
getHealthThreshold()
The minimum number of child health checks that must be healthy for
Route 53 to consider the parent health check to be healthy.
|
Boolean |
getInverted()
A boolean value that indicates whether the status of health check
should be inverted.
|
String |
getIPAddress()
IP Address of the instance being checked.
|
Boolean |
getMeasureLatency()
A Boolean value that indicates whether you want Route 53 to measure
the latency between health checkers in multiple AWS regions and your
endpoint and to display CloudWatch latency graphs in the Route 53
console.
|
Integer |
getPort()
Port on which connection will be opened to the instance to health
check.
|
Integer |
getRequestInterval()
The number of seconds between the time that Route 53 gets a response
from your endpoint and the time that it sends the next health-check
request.
|
String |
getResourcePath()
Path to ping on the instance to check the health.
|
String |
getSearchString()
A string to search for in the body of a health check response.
|
String |
getType()
The type of health check to be performed.
|
int |
hashCode() |
Boolean |
isInverted()
A boolean value that indicates whether the status of health check
should be inverted.
|
Boolean |
isMeasureLatency()
A Boolean value that indicates whether you want Route 53 to measure
the latency between health checkers in multiple AWS regions and your
endpoint and to display CloudWatch latency graphs in the Route 53
console.
|
void |
setChildHealthChecks(Collection<String> childHealthChecks)
For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks. |
void |
setFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa.
|
void |
setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
|
void |
setHealthThreshold(Integer healthThreshold)
The minimum number of child health checks that must be healthy for
Route 53 to consider the parent health check to be healthy.
|
void |
setInverted(Boolean inverted)
A boolean value that indicates whether the status of health check
should be inverted.
|
void |
setIPAddress(String iPAddress)
IP Address of the instance being checked.
|
void |
setMeasureLatency(Boolean measureLatency)
A Boolean value that indicates whether you want Route 53 to measure
the latency between health checkers in multiple AWS regions and your
endpoint and to display CloudWatch latency graphs in the Route 53
console.
|
void |
setPort(Integer port)
Port on which connection will be opened to the instance to health
check.
|
void |
setRequestInterval(Integer requestInterval)
The number of seconds between the time that Route 53 gets a response
from your endpoint and the time that it sends the next health-check
request.
|
void |
setResourcePath(String resourcePath)
Path to ping on the instance to check the health.
|
void |
setSearchString(String searchString)
A string to search for in the body of a health check response.
|
void |
setType(HealthCheckType type)
The type of health check to be performed.
|
void |
setType(String type)
The type of health check to be performed.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
HealthCheckConfig |
withChildHealthChecks(Collection<String> childHealthChecks)
For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks. |
HealthCheckConfig |
withChildHealthChecks(String... childHealthChecks)
For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks. |
HealthCheckConfig |
withFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa.
|
HealthCheckConfig |
withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
|
HealthCheckConfig |
withHealthThreshold(Integer healthThreshold)
The minimum number of child health checks that must be healthy for
Route 53 to consider the parent health check to be healthy.
|
HealthCheckConfig |
withInverted(Boolean inverted)
A boolean value that indicates whether the status of health check
should be inverted.
|
HealthCheckConfig |
withIPAddress(String iPAddress)
IP Address of the instance being checked.
|
HealthCheckConfig |
withMeasureLatency(Boolean measureLatency)
A Boolean value that indicates whether you want Route 53 to measure
the latency between health checkers in multiple AWS regions and your
endpoint and to display CloudWatch latency graphs in the Route 53
console.
|
HealthCheckConfig |
withPort(Integer port)
Port on which connection will be opened to the instance to health
check.
|
HealthCheckConfig |
withRequestInterval(Integer requestInterval)
The number of seconds between the time that Route 53 gets a response
from your endpoint and the time that it sends the next health-check
request.
|
HealthCheckConfig |
withResourcePath(String resourcePath)
Path to ping on the instance to check the health.
|
HealthCheckConfig |
withSearchString(String searchString)
A string to search for in the body of a health check response.
|
HealthCheckConfig |
withType(HealthCheckType type)
The type of health check to be performed.
|
HealthCheckConfig |
withType(String type)
The type of health check to be performed.
|
public String getIPAddress()
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
public void setIPAddress(String iPAddress)
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
iPAddress - IP Address of the instance being checked.public HealthCheckConfig withIPAddress(String iPAddress)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
iPAddress - IP Address of the instance being checked.public Integer getPort()
Constraints:
Range: 1 - 65535
public void setPort(Integer port)
Constraints:
Range: 1 - 65535
port - Port on which connection will be opened to the instance to health
check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is
not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if
the port is not specified.public HealthCheckConfig withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 65535
port - Port on which connection will be opened to the instance to health
check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is
not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if
the port is not specified.public String getType()
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED
HealthCheckTypepublic void setType(String type)
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED
type - The type of health check to be performed. Currently supported types
are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.HealthCheckTypepublic HealthCheckConfig withType(String type)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED
type - The type of health check to be performed. Currently supported types
are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.HealthCheckTypepublic void setType(HealthCheckType type)
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED
type - The type of health check to be performed. Currently supported types
are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.HealthCheckTypepublic HealthCheckConfig withType(HealthCheckType type)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED
type - The type of health check to be performed. Currently supported types
are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.HealthCheckTypepublic String getResourcePath()
Constraints:
Length: 0 - 255
public void setResourcePath(String resourcePath)
Constraints:
Length: 0 - 255
resourcePath - Path to ping on the instance to check the health. Required for HTTP,
HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request
is issued to the instance on the given port and path.public HealthCheckConfig withResourcePath(String resourcePath)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
resourcePath - Path to ping on the instance to check the health. Required for HTTP,
HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request
is issued to the instance on the given port and path.public String getFullyQualifiedDomainName()
Constraints:
Length: 0 - 255
public void setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Constraints:
Length: 0 - 255
fullyQualifiedDomainName - Fully qualified domain name of the instance to be health checked.public HealthCheckConfig withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
fullyQualifiedDomainName - Fully qualified domain name of the instance to be health checked.public String getSearchString()
Constraints:
Length: 0 - 255
public void setSearchString(String searchString)
Constraints:
Length: 0 - 255
searchString - A string to search for in the body of a health check response.
Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.public HealthCheckConfig withSearchString(String searchString)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
searchString - A string to search for in the body of a health check response.
Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.public Integer getRequestInterval()
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Constraints:
Range: 10 - 30
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
public void setRequestInterval(Integer requestInterval)
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Constraints:
Range: 10 - 30
requestInterval - The number of seconds between the time that Route 53 gets a response
from your endpoint and the time that it sends the next health-check
request. Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
public HealthCheckConfig withRequestInterval(Integer requestInterval)
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 10 - 30
requestInterval - The number of seconds between the time that Route 53 gets a response
from your endpoint and the time that it sends the next health-check
request. Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
public Integer getFailureThreshold()
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Constraints:
Range: 1 - 10
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
public void setFailureThreshold(Integer failureThreshold)
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Constraints:
Range: 1 - 10
failureThreshold - The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
public HealthCheckConfig withFailureThreshold(Integer failureThreshold)
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 10
failureThreshold - The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
public Boolean isMeasureLatency()
public void setMeasureLatency(Boolean measureLatency)
measureLatency - A Boolean value that indicates whether you want Route 53 to measure
the latency between health checkers in multiple AWS regions and your
endpoint and to display CloudWatch latency graphs in the Route 53
console.public HealthCheckConfig withMeasureLatency(Boolean measureLatency)
Returns a reference to this object so that method calls can be chained together.
measureLatency - A Boolean value that indicates whether you want Route 53 to measure
the latency between health checkers in multiple AWS regions and your
endpoint and to display CloudWatch latency graphs in the Route 53
console.public Boolean getMeasureLatency()
public Boolean isInverted()
Inverted is True, then Route 53 considers
the health check to be unhealthy.Inverted is True, then Route 53 considers
the health check to be unhealthy.public void setInverted(Boolean inverted)
Inverted is True, then Route 53 considers
the health check to be unhealthy.inverted - A boolean value that indicates whether the status of health check
should be inverted. For example, if a health check is healthy but
Inverted is True, then Route 53 considers
the health check to be unhealthy.public HealthCheckConfig withInverted(Boolean inverted)
Inverted is True, then Route 53 considers
the health check to be unhealthy.
Returns a reference to this object so that method calls can be chained together.
inverted - A boolean value that indicates whether the status of health check
should be inverted. For example, if a health check is healthy but
Inverted is True, then Route 53 considers
the health check to be unhealthy.public Boolean getInverted()
Inverted is True, then Route 53 considers
the health check to be unhealthy.Inverted is True, then Route 53 considers
the health check to be unhealthy.public Integer getHealthThreshold()
Constraints:
Range: 0 - 256
public void setHealthThreshold(Integer healthThreshold)
Constraints:
Range: 0 - 256
healthThreshold - The minimum number of child health checks that must be healthy for
Route 53 to consider the parent health check to be healthy. Valid
values are integers between 0 and 256, inclusive.public HealthCheckConfig withHealthThreshold(Integer healthThreshold)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 - 256
healthThreshold - The minimum number of child health checks that must be healthy for
Route 53 to consider the parent health check to be healthy. Valid
values are integers between 0 and 256, inclusive.public List<String> getChildHealthChecks()
HealthCheckId values for the associated child health
checks.
Constraints:
Length: 0 - 256
HealthCheckId values for the associated child health
checks.public void setChildHealthChecks(Collection<String> childHealthChecks)
HealthCheckId values for the associated child health
checks.
Constraints:
Length: 0 - 256
childHealthChecks - For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks.public HealthCheckConfig withChildHealthChecks(String... childHealthChecks)
HealthCheckId values for the associated child health
checks.
NOTE: This method appends the values to the existing list (if
any). Use setChildHealthChecks(java.util.Collection) or
withChildHealthChecks(java.util.Collection) if you want to
override the existing values.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 256
childHealthChecks - For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks.public HealthCheckConfig withChildHealthChecks(Collection<String> childHealthChecks)
HealthCheckId values for the associated child health
checks.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 256
childHealthChecks - For a specified parent health check, a list of
HealthCheckId values for the associated child health
checks.public String toString()
toString in class ObjectObject.toString()public HealthCheckConfig clone()
Copyright © 2015. All rights reserved.