HealthCheckConfig
A complex type that contains information about the health check.
Contents
- Type
-
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
Important
You can't change the value of
Type
after you create a health check.You can create the following types of health checks:
-
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
-
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
Important
If you specify
HTTPS
for the value ofType
, the endpoint must support TLS v1.0, v1.1, or v1.2. -
HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an
HTTPS
request and searches the first 5,120 bytes of the response body for the string that you specify inSearchString
. -
TCP: 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 isALARM
, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state isOK
orALARM
, the health check status depends on the setting forInsufficientDataHealthStatus
:Healthy
,Unhealthy
, orLastKnownStatus
. -
CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of
HealthThreshold
. -
RECOVERY_CONTROL: The health check is associated with a Route53 Application Recovery Controller routing control. If the routing control state is
ON
, the health check is considered healthy. If the state isOFF
, the health check is considered unhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
Type: String
Valid Values:
HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP | CALCULATED | CLOUDWATCH_METRIC | RECOVERY_CONTROL
Required: Yes
-
- AlarmIdentifier
-
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
Type: AlarmIdentifier object
Required: No
- ChildHealthChecks
-
(CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck
element for each health check that you want to associate with aCALCULATED
health check.Type: Array of strings
Array Members: Maximum number of 256 items.
Length Constraints: Maximum length of 64.
Required: No
- Disabled
-
Stops Route 53 from performing health checks. When you disable a health check, here's what happens:
-
Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
-
Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
-
Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing
. Type: Boolean
Required: No
-
- EnableSNI
-
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName
to the endpoint in theclient_hello
message during TLS negotiation. This allows the endpoint to respond toHTTPS
health check requests with the applicable SSL/TLS certificate.Some endpoints require that
HTTPS
requests include the host name in theclient_hello
message. If you don't enable SNI, the status of the health check will beSSL 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 theSubject Alternative Names
field. One of the domain names in the certificate should match the value that you specify forFullyQualifiedDomainName
. If the endpoint responds to theclient_hello
message with a certificate that does not include the domain name that you specified inFullyQualifiedDomainName
, a health checker will retry the handshake. In the second attempt, the health checker will omitFullyQualifiedDomainName
from theclient_hello
message.Type: Boolean
Required: No
- 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.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- 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 theHost
header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.When Route 53 checks the health of an endpoint, here is how it constructs the
Host
header:-
If you specify a value of
80
forPort
andHTTP
orHTTP_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in the Host header. -
If you specify a value of
443
forPort
andHTTPS
orHTTPS_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in theHost
header. -
If you specify another value for
Port
and any value exceptTCP
forType
, Route 53 passesFullyQualifiedDomainName:Port
to the endpoint in theHost
header.
If you don't specify a value for
FullyQualifiedDomainName
, Route 53 substitutes the value ofIPAddress
in theHost
header in each of the preceding cases.If you don't specify a value for
IPAddress
:Route 53 sends a DNS request to the domain that you specify for
FullyQualifiedDomainName
at the interval that you specify forRequestInterval
. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.Note
If you don't specify a value for
IPAddress
, 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 forFullyQualifiedDomainName
, 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 ofFullyQualifiedDomainName
, 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).Important
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
isHTTP
,HTTPS
,HTTP_STR_MATCH
, orHTTPS_STR_MATCH
, Route 53 passes the value ofFullyQualifiedDomainName
in theHost
header, as it does when you specify a value forIPAddress
. If the value ofType
isTCP
, Route 53 doesn't pass aHost
header.Type: String
Length Constraints: Maximum length of 255.
Required: No
-
- HealthThreshold
-
The number of child health checks that are associated with a
CALCULATED
health check that Amazon Route 53 must consider healthy for theCALCULATED
health check to be considered healthy. To specify the child health checks that you want to associate with aCALCULATED
health check, use the ChildHealthChecks element.Note the following:
-
If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
-
If you specify
0
, Route 53 always considers this health check to be healthy.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 256.
Required: No
-
- 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
: Route 53 considers the health check to be healthy. -
Unhealthy
: Route 53 considers the health check to be unhealthy. -
LastKnownStatus
: 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.
Type: String
Valid Values:
Healthy | Unhealthy | LastKnownStatus
Required: No
-
- 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.
Type: Boolean
Required: No
- 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
, Route 53 sends a DNS request to resolve the domain name that you specify inFullyQualifiedDomainName
at the interval that you specify inRequestInterval
. Using an IP address returned by DNS, 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 FullyQualifiedDomainName.
Constraints: 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
isCALCULATED
orCLOUDWATCH_METRIC
, omitIPAddress
.Type: String
Length Constraints: Maximum length of 45.
Pattern:
(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)
Required: No
-
- MeasureLatency
-
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.
Important
You can't change the value of
MeasureLatency
after you create a health check.Type: Boolean
Required: No
- Port
-
The port on the endpoint that you want Amazon Route 53 to perform health checks on.
Note
Don't specify a value for
Port
when you specify a value forType
ofCLOUDWATCH_METRIC
orCALCULATED
.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
- 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, 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, 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).
Type: Array of strings
Array Members: Minimum number of 3 items. Maximum number of 64 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1
Required: No
- 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 Route 53 health checker makes requests at this interval.
Important
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 is30
seconds.Type: Integer
Valid Range: Minimum value of 10. Maximum value of 30.
Required: No
- 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. You can also include query string parameters, for example,
/welcome.html?language=jp&login=y
.Type: String
Length Constraints: Maximum length of 255.
Required: No
- RoutingControlArn
-
The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.
For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- SearchString
-
If the value of Type is
HTTP_STR_MATCH
orHTTPS_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, Route 53 considers the resource healthy.Route 53 considers case when searching for
SearchString
in the response body.Type: String
Length Constraints: Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: