@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class HealthCheckConfig extends Object implements Serializable, Cloneable
A complex type that contains information about the health check.
| Constructor and Description |
|---|
HealthCheckConfig() |
| Modifier and Type | Method and Description |
|---|---|
HealthCheckConfig |
clone() |
boolean |
equals(Object obj) |
AlarmIdentifier |
getAlarmIdentifier()
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to
determine whether this health check is healthy.
|
List<String> |
getChildHealthChecks()
(CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check. |
Boolean |
getEnableSNI()
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. |
Integer |
getFailureThreshold()
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the
current status of the endpoint from unhealthy to healthy or vice versa.
|
String |
getFullyQualifiedDomainName()
Amazon Route 53 behavior depends on whether you specify a value for
IPAddress. |
Integer |
getHealthThreshold()
The number of child health checks that are associated with a
CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. |
String |
getInsufficientDataHealthStatus()
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want
Amazon Route 53 to assign to the health check:
|
Boolean |
getInverted()
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a
health check unhealthy when it otherwise would be considered healthy.
|
String |
getIPAddress()
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on.
|
Boolean |
getMeasureLatency()
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions
and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route
53 console.
|
Integer |
getPort()
The port on the endpoint on which you want Amazon Route 53 to perform health checks.
|
List<String> |
getRegions()
A complex type that contains one
Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint. |
Integer |
getRequestInterval()
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that
it sends the next health check request.
|
String |
getResourcePath()
The path, if any, that you want Amazon Route 53 to request when performing health checks.
|
String |
getSearchString()
If the value of Type is
HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. |
String |
getType()
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
int |
hashCode() |
Boolean |
isEnableSNI()
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. |
Boolean |
isInverted()
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a
health check unhealthy when it otherwise would be considered healthy.
|
Boolean |
isMeasureLatency()
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions
and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route
53 console.
|
void |
setAlarmIdentifier(AlarmIdentifier alarmIdentifier)
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to
determine whether this health check is healthy.
|
void |
setChildHealthChecks(Collection<String> childHealthChecks)
(CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check. |
void |
setEnableSNI(Boolean enableSNI)
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. |
void |
setFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the
current status of the endpoint from unhealthy to healthy or vice versa.
|
void |
setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Amazon Route 53 behavior depends on whether you specify a value for
IPAddress. |
void |
setHealthThreshold(Integer healthThreshold)
The number of child health checks that are associated with a
CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. |
void |
setInsufficientDataHealthStatus(InsufficientDataHealthStatus insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want
Amazon Route 53 to assign to the health check:
|
void |
setInsufficientDataHealthStatus(String insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want
Amazon Route 53 to assign to the health check:
|
void |
setInverted(Boolean inverted)
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a
health check unhealthy when it otherwise would be considered healthy.
|
void |
setIPAddress(String iPAddress)
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on.
|
void |
setMeasureLatency(Boolean measureLatency)
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions
and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route
53 console.
|
void |
setPort(Integer port)
The port on the endpoint on which you want Amazon Route 53 to perform health checks.
|
void |
setRegions(Collection<String> regions)
A complex type that contains one
Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint. |
void |
setRequestInterval(Integer requestInterval)
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that
it sends the next health check request.
|
void |
setResourcePath(String resourcePath)
The path, if any, that you want Amazon Route 53 to request when performing health checks.
|
void |
setSearchString(String searchString)
If the value of Type is
HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. |
void |
setType(HealthCheckType type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
void |
setType(String type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
HealthCheckConfig |
withAlarmIdentifier(AlarmIdentifier alarmIdentifier)
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to
determine whether this health check is healthy.
|
HealthCheckConfig |
withChildHealthChecks(Collection<String> childHealthChecks)
(CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check. |
HealthCheckConfig |
withChildHealthChecks(String... childHealthChecks)
(CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check. |
HealthCheckConfig |
withEnableSNI(Boolean enableSNI)
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. |
HealthCheckConfig |
withFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the
current status of the endpoint from unhealthy to healthy or vice versa.
|
HealthCheckConfig |
withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Amazon Route 53 behavior depends on whether you specify a value for
IPAddress. |
HealthCheckConfig |
withHealthThreshold(Integer healthThreshold)
The number of child health checks that are associated with a
CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. |
HealthCheckConfig |
withInsufficientDataHealthStatus(InsufficientDataHealthStatus insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want
Amazon Route 53 to assign to the health check:
|
HealthCheckConfig |
withInsufficientDataHealthStatus(String insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want
Amazon Route 53 to assign to the health check:
|
HealthCheckConfig |
withInverted(Boolean inverted)
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a
health check unhealthy when it otherwise would be considered healthy.
|
HealthCheckConfig |
withIPAddress(String iPAddress)
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on.
|
HealthCheckConfig |
withMeasureLatency(Boolean measureLatency)
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions
and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route
53 console.
|
HealthCheckConfig |
withPort(Integer port)
The port on the endpoint on which you want Amazon Route 53 to perform health checks.
|
HealthCheckConfig |
withRegions(Collection<String> regions)
A complex type that contains one
Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint. |
HealthCheckConfig |
withRegions(HealthCheckRegion... regions)
A complex type that contains one
Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint. |
HealthCheckConfig |
withRegions(String... regions)
A complex type that contains one
Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint. |
HealthCheckConfig |
withRequestInterval(Integer requestInterval)
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that
it sends the next health check request.
|
HealthCheckConfig |
withResourcePath(String resourcePath)
The path, if any, that you want Amazon Route 53 to request when performing health checks.
|
HealthCheckConfig |
withSearchString(String searchString)
If the value of Type is
HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. |
HealthCheckConfig |
withType(HealthCheckType type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
HealthCheckConfig |
withType(String type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
public void setIPAddress(String iPAddress)
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you
don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name
that you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the
endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC
5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your
EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of
your instance will never change.
For more information, see HealthCheckConfig$FullyQualifiedDomainName.
Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
iPAddress - The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If
you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the
domain name that you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health
of the endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in
RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with
your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP
address of your instance will never change.
For more information, see HealthCheckConfig$FullyQualifiedDomainName.
Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
public String getIPAddress()
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you
don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name
that you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the
endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC
5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your
EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of
your instance will never change.
For more information, see HealthCheckConfig$FullyQualifiedDomainName.
Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
IPAddress, Amazon Route 53 sends a DNS request to resolve the
domain name that you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health
of the endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in
RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with
your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the
IP address of your instance will never change.
For more information, see HealthCheckConfig$FullyQualifiedDomainName.
Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
public HealthCheckConfig withIPAddress(String iPAddress)
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you
don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name
that you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the
endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC
5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your
EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of
your instance will never change.
For more information, see HealthCheckConfig$FullyQualifiedDomainName.
Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
iPAddress - The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If
you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the
domain name that you specify in FullyQualifiedDomainName at the interval that you specify in
RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health
of the endpoint.
Use one of the following formats for the value of IPAddress:
IPv4 address: four values between 0 and 255, separated by periods (.), for example,
192.0.2.44.
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in
RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with
your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP
address of your instance will never change.
For more information, see HealthCheckConfig$FullyQualifiedDomainName.
Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit
IPAddress.
public void setPort(Integer port)
The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for
Port only when you specify a value for IPAddress.
port - The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for
Port only when you specify a value for IPAddress.public Integer getPort()
The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for
Port only when you specify a value for IPAddress.
Port only when you specify a value for IPAddress.public HealthCheckConfig withPort(Integer port)
The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for
Port only when you specify a value for IPAddress.
port - The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for
Port only when you specify a value for IPAddress.public void setType(String type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or
later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify
in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that
you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is
OK, the health check is considered healthy. If the state is ALARM, the health check is
considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is
OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the
number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with
the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
type - The type of health check that you want to create, which indicates how Amazon Route 53 determines whether
an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0
or later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you
specify in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route
53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the
string that you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the
alarm is OK, the health check is considered healthy. If the state is ALARM, the
health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the
state is OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds
up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares
that number with the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckTypepublic String getType()
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or
later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify
in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that
you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is
OK, the health check is considered healthy. If the state is ALARM, the health check is
considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is
OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the
number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with
the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0
or later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route
53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that
you specify in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route
53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the
string that you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the
alarm is OK, the health check is considered healthy. If the state is ALARM, the
health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the
state is OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds
up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares
that number with the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckTypepublic HealthCheckConfig withType(String type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or
later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify
in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that
you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is
OK, the health check is considered healthy. If the state is ALARM, the health check is
considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is
OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the
number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with
the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
type - The type of health check that you want to create, which indicates how Amazon Route 53 determines whether
an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0
or later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you
specify in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route
53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the
string that you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the
alarm is OK, the health check is considered healthy. If the state is ALARM, the
health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the
state is OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds
up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares
that number with the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckTypepublic void setType(HealthCheckType type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or
later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify
in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that
you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is
OK, the health check is considered healthy. If the state is ALARM, the health check is
considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is
OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the
number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with
the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
type - The type of health check that you want to create, which indicates how Amazon Route 53 determines whether
an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0
or later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you
specify in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route
53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the
string that you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the
alarm is OK, the health check is considered healthy. If the state is ALARM, the
health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the
state is OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds
up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares
that number with the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckTypepublic HealthCheckConfig withType(HealthCheckType type)
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or
later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify
in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that
you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is
OK, the health check is considered healthy. If the state is ALARM, the health check is
considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is
OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the
number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with
the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
type - The type of health check that you want to create, which indicates how Amazon Route 53 determines whether
an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0
or later.
HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53
submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you
specify in SearchString.
HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route
53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the
string that you specify in SearchString.
TCP: Amazon Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the
alarm is OK, the health check is considered healthy. If the state is ALARM, the
health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the
state is OK or ALARM, the health check status depends on the setting for
InsufficientDataHealthStatus: Healthy, Unhealthy, or
LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds
up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares
that number with the value of HealthThreshold.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckTypepublic void setResourcePath(String resourcePath)
The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.
resourcePath - The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be
any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is
healthy, for example, the file /docs/route53-health-check.html.public String getResourcePath()
The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.
public HealthCheckConfig withResourcePath(String resourcePath)
The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.
resourcePath - The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be
any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is
healthy, for example, the file /docs/route53-health-check.html.public void setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP health
checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to
perform health checks.
When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for Type,
Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host
header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of
IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at
the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon
Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to
the endpoint. If there's no resource record set with a type of A for the name that you specify for
FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify
the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check
for each endpoint. For example, create a health check for each HTTP server that is serving content for
www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server
(such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
In this configuration, if you create a health check for which the value of FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with those resource record
sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value for
IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a
Host header.
fullyQualifiedDomainName - Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP
health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon
Route 53 to perform health checks.
When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host
header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for
Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in
the Host header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the
value of IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Amazon Route 53 sends a DNS request to the domain that you specify for
FullyQualifiedDomainName at the interval that you specify for RequestInterval.
Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health
checks to the endpoint. If there's no resource record set with a type of A for the name that you specify
for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to
specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a
separate health check for each endpoint. For example, create a health check for each HTTP server that is
serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the
domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets
(www.example.com).
In this configuration, if you create a health check for which the value of
FullyQualifiedDomainName matches the name of the resource record sets and you then associate
the health check with those resource record sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value
for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't
pass a Host header.
public String getFullyQualifiedDomainName()
Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP health
checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to
perform health checks.
When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for Type,
Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host
header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of
IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at
the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon
Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to
the endpoint. If there's no resource record set with a type of A for the name that you specify for
FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify
the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check
for each endpoint. For example, create a health check for each HTTP server that is serving content for
www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server
(such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
In this configuration, if you create a health check for which the value of FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with those resource record
sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value for
IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a
Host header.
IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP
health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon
Route 53 to perform health checks.
When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host
header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for
Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in
the Host header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the
value of IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Amazon Route 53 sends a DNS request to the domain that you specify for
FullyQualifiedDomainName at the interval that you specify for RequestInterval.
Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health
checks to the endpoint. If there's no resource record set with a type of A for the name that you specify
for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to
specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a
separate health check for each endpoint. For example, create a health check for each HTTP server that is
serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the
domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets
(www.example.com).
In this configuration, if you create a health check for which the value of
FullyQualifiedDomainName matches the name of the resource record sets and you then associate
the health check with those resource record sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a
value for IPAddress. If the value of Type is TCP, Amazon Route 53
doesn't pass a Host header.
public HealthCheckConfig withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP health
checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to
perform health checks.
When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for Type,
Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host
header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of
IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at
the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon
Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to
the endpoint. If there's no resource record set with a type of A for the name that you specify for
FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify
the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check
for each endpoint. For example, create a health check for each HTTP server that is serving content for
www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server
(such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).
In this configuration, if you create a health check for which the value of FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with those resource record
sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value for
IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a
Host header.
fullyQualifiedDomainName - Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
If you specify a value for IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of
FullyQualifiedDomainName in the Host header for all health checks except TCP
health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon
Route 53 to perform health checks.
When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host
header:
If you specify a value of 80 for Port and HTTP or
HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or
HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for
Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in
the Host header.
If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the
value of IPAddress in the Host header in each of the preceding cases.
If you don't specify a value for IPAddress :
Amazon Route 53 sends a DNS request to the domain that you specify for
FullyQualifiedDomainName at the interval that you specify for RequestInterval.
Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health
checks to the endpoint. If there's no resource record set with a type of A for the name that you specify
for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.
If you want to check the health of weighted, latency, or failover resource record sets and you choose to
specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a
separate health check for each endpoint. For example, create a health check for each HTTP server that is
serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the
domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets
(www.example.com).
In this configuration, if you create a health check for which the value of
FullyQualifiedDomainName matches the name of the resource record sets and you then associate
the health check with those resource record sets, health check results will be unpredictable.
In addition, if the value that you specify for Type is HTTP, HTTPS,
HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of
FullyQualifiedDomainName in the Host header, as it does when you specify a value
for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't
pass a Host header.
public void setSearchString(String searchString)
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the
response body, Amazon Route 53 considers the resource healthy.
Amazon Route 53 considers case when searching for SearchString in the response body.
searchString - If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you
want Amazon Route 53 to search for in the response body from the specified resource. If the string appears
in the response body, Amazon Route 53 considers the resource healthy.
Amazon Route 53 considers case when searching for SearchString in the response body.
public String getSearchString()
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the
response body, Amazon Route 53 considers the resource healthy.
Amazon Route 53 considers case when searching for SearchString in the response body.
HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you
want Amazon Route 53 to search for in the response body from the specified resource. If the string
appears in the response body, Amazon Route 53 considers the resource healthy.
Amazon Route 53 considers case when searching for SearchString in the response body.
public HealthCheckConfig withSearchString(String searchString)
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want
Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the
response body, Amazon Route 53 considers the resource healthy.
Amazon Route 53 considers case when searching for SearchString in the response body.
searchString - If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you
want Amazon Route 53 to search for in the response body from the specified resource. If the string appears
in the response body, Amazon Route 53 considers the resource healthy.
Amazon Route 53 considers case when searching for SearchString in the response body.
public void setRequestInterval(Integer requestInterval)
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at this interval.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30 seconds.
requestInterval - The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the
time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at
this interval.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30
seconds.
public Integer getRequestInterval()
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at this interval.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30 seconds.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30
seconds.
public HealthCheckConfig withRequestInterval(Integer requestInterval)
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at this interval.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30 seconds.
requestInterval - The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the
time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at
this interval.
You can't change the value of RequestInterval after you create a health check.
If you don't specify a value for RequestInterval, the default value is 30
seconds.
public void setFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
failureThreshold - The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change
the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer
Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
public Integer getFailureThreshold()
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
If you don't specify a value for FailureThreshold, the default value is three health checks.
public HealthCheckConfig withFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
failureThreshold - The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change
the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer
Guide.
If you don't specify a value for FailureThreshold, the default value is three health checks.
public void setMeasureLatency(Boolean measureLatency)
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
measureLatency - Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS
regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in
the Amazon Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
public Boolean getMeasureLatency()
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
You can't change the value of MeasureLatency after you create a health check.
public HealthCheckConfig withMeasureLatency(Boolean measureLatency)
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
measureLatency - Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS
regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in
the Amazon Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
public Boolean isMeasureLatency()
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
You can't change the value of MeasureLatency after you create a health check.
public void setInverted(Boolean inverted)
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
inverted - Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider
a health check unhealthy when it otherwise would be considered healthy.public Boolean getInverted()
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
public HealthCheckConfig withInverted(Boolean inverted)
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
inverted - Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider
a health check unhealthy when it otherwise would be considered healthy.public Boolean isInverted()
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
public void setHealthThreshold(Integer healthThreshold)
The number of child health checks that are associated with a CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. To specify the child
health checks that you want to associate with a CALCULATED health check, use the
HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
healthThreshold - The number of child health checks that are associated with a CALCULATED health that Amazon
Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To
specify the child health checks that you want to associate with a CALCULATED health check,
use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks
elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
public Integer getHealthThreshold()
The number of child health checks that are associated with a CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. To specify the child
health checks that you want to associate with a CALCULATED health check, use the
HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
CALCULATED health that Amazon
Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To
specify the child health checks that you want to associate with a CALCULATED health check,
use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks
elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
public HealthCheckConfig withHealthThreshold(Integer healthThreshold)
The number of child health checks that are associated with a CALCULATED health that Amazon Route 53
must consider healthy for the CALCULATED health check to be considered healthy. To specify the child
health checks that you want to associate with a CALCULATED health check, use the
HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
healthThreshold - The number of child health checks that are associated with a CALCULATED health that Amazon
Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To
specify the child health checks that you want to associate with a CALCULATED health check,
use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks
elements.
Note the following:
If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0, Amazon Route 53 always considers this health check to be healthy.
public List<String> getChildHealthChecks()
(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check.
ChildHealthCheck element
for each health check that you want to associate with a CALCULATED health check.public void setChildHealthChecks(Collection<String> childHealthChecks)
(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check.
childHealthChecks - (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for
each health check that you want to associate with a CALCULATED health check.public HealthCheckConfig withChildHealthChecks(String... childHealthChecks)
(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check.
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.
childHealthChecks - (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for
each health check that you want to associate with a CALCULATED health check.public HealthCheckConfig withChildHealthChecks(Collection<String> childHealthChecks)
(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check.
childHealthChecks - (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for
each health check that you want to associate with a CALCULATED health check.public void setEnableSNI(Boolean enableSNI)
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to
HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the client_hello
message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the
error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint
responds to the client_hello message with a certificate that does not include the domain name that
you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second
attempt, the health checker will omit FullyQualifiedDomainName from the client_hello
message.
enableSNI - Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to
respond to HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the
client_hello message. If you don't enable SNI, the status of the health check will be
SSL alert handshake_failure. A health check can also have that status for other reasons. If
SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and
confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the
endpoint responds to the client_hello message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName, a health checker will retry the
handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from
the client_hello message.
public Boolean getEnableSNI()
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to
HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the client_hello
message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the
error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint
responds to the client_hello message with a certificate that does not include the domain name that
you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second
attempt, the health checker will omit FullyQualifiedDomainName from the client_hello
message.
FullyQualifiedDomainName to
the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to
respond to HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the
client_hello message. If you don't enable SNI, the status of the health check will be
SSL alert handshake_failure. A health check can also have that status for other reasons. If
SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and
confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the
endpoint responds to the client_hello message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName, a health checker will retry the
handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from
the client_hello message.
public HealthCheckConfig withEnableSNI(Boolean enableSNI)
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to
HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the client_hello
message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the
error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint
responds to the client_hello message with a certificate that does not include the domain name that
you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second
attempt, the health checker will omit FullyQualifiedDomainName from the client_hello
message.
enableSNI - Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to
respond to HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the
client_hello message. If you don't enable SNI, the status of the health check will be
SSL alert handshake_failure. A health check can also have that status for other reasons. If
SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and
confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the
endpoint responds to the client_hello message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName, a health checker will retry the
handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from
the client_hello message.
public Boolean isEnableSNI()
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the
endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to
HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the client_hello
message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure
. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the
error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint
responds to the client_hello message with a certificate that does not include the domain name that
you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second
attempt, the health checker will omit FullyQualifiedDomainName from the client_hello
message.
FullyQualifiedDomainName to
the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to
respond to HTTPS health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the
client_hello message. If you don't enable SNI, the status of the health check will be
SSL alert handshake_failure. A health check can also have that status for other reasons. If
SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and
confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and
possibly several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the
endpoint responds to the client_hello message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName, a health checker will retry the
handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from
the client_hello message.
public List<String> getRegions()
A complex type that contains one Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
Region element for each region from which you want Amazon
Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
HealthCheckRegionpublic void setRegions(Collection<String> regions)
A complex type that contains one Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
regions - A complex type that contains one Region element for each region from which you want Amazon
Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
HealthCheckRegionpublic HealthCheckConfig withRegions(String... regions)
A complex type that contains one Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
NOTE: This method appends the values to the existing list (if any). Use
setRegions(java.util.Collection) or withRegions(java.util.Collection) if you want to override
the existing values.
regions - A complex type that contains one Region element for each region from which you want Amazon
Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
HealthCheckRegionpublic HealthCheckConfig withRegions(Collection<String> regions)
A complex type that contains one Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
regions - A complex type that contains one Region element for each region from which you want Amazon
Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
HealthCheckRegionpublic HealthCheckConfig withRegions(HealthCheckRegion... regions)
A complex type that contains one Region element for each region from which you want Amazon Route 53
health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
regions - A complex type that contains one Region element for each region from which you want Amazon
Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
HealthCheckRegionpublic void setAlarmIdentifier(AlarmIdentifier alarmIdentifier)
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
alarmIdentifier - A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use
to determine whether this health check is healthy.public AlarmIdentifier getAlarmIdentifier()
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
public HealthCheckConfig withAlarmIdentifier(AlarmIdentifier alarmIdentifier)
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
alarmIdentifier - A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use
to determine whether this health check is healthy.public void setInsufficientDataHealthStatus(String insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
insufficientDataHealthStatus - When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you
want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
InsufficientDataHealthStatuspublic String getInsufficientDataHealthStatus()
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last
known status, the default status for the health check is healthy.
InsufficientDataHealthStatuspublic HealthCheckConfig withInsufficientDataHealthStatus(String insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
insufficientDataHealthStatus - When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you
want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
InsufficientDataHealthStatuspublic void setInsufficientDataHealthStatus(InsufficientDataHealthStatus insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
insufficientDataHealthStatus - When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you
want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
InsufficientDataHealthStatuspublic HealthCheckConfig withInsufficientDataHealthStatus(InsufficientDataHealthStatus insufficientDataHealthStatus)
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
insufficientDataHealthStatus - When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you
want Amazon Route 53 to assign to the health check:
Healthy: Amazon Route 53 considers the health check to be healthy.
Unhealthy: Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that
CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known
status, the default status for the health check is healthy.
InsufficientDataHealthStatuspublic String toString()
toString in class ObjectObject.toString()public HealthCheckConfig clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.