Class GetHealthCheckStatusRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.route53.model.GetHealthCheckStatusRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class GetHealthCheckStatusRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
A complex type that contains information about the request to get health check status for a health check.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description GetHealthCheckStatusRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetHealthCheckStatusRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getHealthCheckId()
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include theHealthCheckId
element and specify the ID of the applicable health check.int
hashCode()
void
setHealthCheckId(String healthCheckId)
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include theHealthCheckId
element and specify the ID of the applicable health check.String
toString()
Returns a string representation of this object; useful for testing and debugging.GetHealthCheckStatusRequest
withHealthCheckId(String healthCheckId)
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include theHealthCheckId
element and specify the ID of the applicable health check.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setHealthCheckId
public void setHealthCheckId(String healthCheckId)
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the
HealthCheckId
element and specify the ID of the applicable health check.Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The
HealthCheckId
element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
-
You set
EvaluateTargetHealth
totrue
for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the
Value
element. When you add aHealthCheckId
element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is
*
), in that order, until it finds a resource record set for which the endpoint is healthy.If your health checks specify the endpoint only by domain name, 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 asus-east-1-www.example.com
), not the name of the resource record sets (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 then associate the health check with those resource record sets, health check results will be unpredictable.- Parameters:
healthCheckId
- If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include theHealthCheckId
element and specify the ID of the applicable health check.Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The
HealthCheckId
element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
-
You set
EvaluateTargetHealth
totrue
for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the
Value
element. When you add aHealthCheckId
element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is
*
), in that order, until it finds a resource record set for which the endpoint is healthy.If your health checks specify the endpoint only by domain name, 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 asus-east-1-www.example.com
), not the name of the resource record sets (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 then associate the health check with those resource record sets, health check results will be unpredictable.
-
getHealthCheckId
public String getHealthCheckId()
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the
HealthCheckId
element and specify the ID of the applicable health check.Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The
HealthCheckId
element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
-
You set
EvaluateTargetHealth
totrue
for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the
Value
element. When you add aHealthCheckId
element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is
*
), in that order, until it finds a resource record set for which the endpoint is healthy.If your health checks specify the endpoint only by domain name, 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 asus-east-1-www.example.com
), not the name of the resource record sets (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 then associate the health check with those resource record sets, health check results will be unpredictable.- Returns:
- If you want Amazon Route 53 to return this resource record set in
response to a DNS query only when a health check is passing,
include the
HealthCheckId
element and specify the ID of the applicable health check.Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The
HealthCheckId
element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
-
You set
EvaluateTargetHealth
totrue
for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the
Value
element. When you add aHealthCheckId
element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is
*
), in that order, until it finds a resource record set for which the endpoint is healthy.If your health checks specify the endpoint only by domain name, 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 asus-east-1-www.example.com
), not the name of the resource record sets (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 then associate the health check with those resource record sets, health check results will be unpredictable.
-
withHealthCheckId
public GetHealthCheckStatusRequest withHealthCheckId(String healthCheckId)
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the
HealthCheckId
element and specify the ID of the applicable health check.Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The
HealthCheckId
element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
-
You set
EvaluateTargetHealth
totrue
for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the
Value
element. When you add aHealthCheckId
element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is
*
), in that order, until it finds a resource record set for which the endpoint is healthy.If your health checks specify the endpoint only by domain name, 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 asus-east-1-www.example.com
), not the name of the resource record sets (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 then associate the health check with those resource record sets, health check results will be unpredictable.- Parameters:
healthCheckId
- If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include theHealthCheckId
element and specify the ID of the applicable health check.Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The
HealthCheckId
element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
-
You set
EvaluateTargetHealth
totrue
for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the
Value
element. When you add aHealthCheckId
element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is
*
), in that order, until it finds a resource record set for which the endpoint is healthy.If your health checks specify the endpoint only by domain name, 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 asus-east-1-www.example.com
), not the name of the resource record sets (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 then associate the health check with those resource record sets, health check results will be unpredictable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public GetHealthCheckStatusRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-