@Generated(value="software.amazon.awssdk:codegen") public class HealthCheckConfig extends Object implements StructuredPojo, ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify
settings for a health check, Amazon Route 53 associates the health check with all the resource record sets that you
specify in DnsConfig
.
The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Amazon Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.
For information about the charges for health checks, see Amazon Route 53 Pricing.
Modifier and Type | Class and Description |
---|---|
static interface |
HealthCheckConfig.Builder |
Modifier and Type | Method and Description |
---|---|
static HealthCheckConfig.Builder |
builder() |
boolean |
equals(Object obj) |
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
resourcePath()
The path that you want Amazon Route 53 to request when performing health checks.
|
static Class<? extends HealthCheckConfig.Builder> |
serializableBuilderClass() |
HealthCheckConfig.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
HealthCheckType |
type()
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
String |
typeString()
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an
endpoint is healthy.
|
copy
public 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.
TCP: Amazon Route 53 tries to establish a TCP connection.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If the service returns an enum value that is not available in the current SDK version, type
will return
HealthCheckType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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.
TCP: Amazon Route 53 tries to establish a TCP connection.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckType
public String typeString()
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.
TCP: Amazon Route 53 tries to establish a TCP connection.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If the service returns an enum value that is not available in the current SDK version, type
will return
HealthCheckType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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.
TCP: Amazon Route 53 tries to establish a TCP connection.
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckType
public String resourcePath()
The path 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, such as the file
/docs/route53-health-check.html
. Amazon Route 53 automatically adds the DNS name for the service and
a leading forward slash (/
) character.
/docs/route53-health-check.html
. Amazon Route 53 automatically adds the DNS
name for the service and a leading forward slash (/
) character.public 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.
public HealthCheckConfig.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
public static HealthCheckConfig.Builder builder()
public static Class<? extends HealthCheckConfig.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.