AWS::ServiceDiscovery::Service HealthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains settings for an
optional health check. If you specify settings for a health check, Amazon Cloud Map associates the health check with
the records that you specify in DnsConfig
.
Important
If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or HealthCheckConfig
but not both.
Health checks are basic Route 53 health checks that monitor an Amazon endpoint. For information
about pricing for health checks, see Amazon Route 53
Pricing
Note the following about configuring health checks.
- A and AAAA records
-
If
DnsConfig
includes configurations for bothA
andAAAA
records, Amazon Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both theA
andAAAA
records to be unhealthy. - CNAME records
-
You can't specify settings for
HealthCheckConfig
when theDNSConfig
includesCNAME
for the value ofType
. If you do, theCreateService
request will fail with anInvalidInput
error. - Request interval
-
A Route 53 health checker in each health-checking Amazon Region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second that's followed by a few seconds with no health checks at all.
- Health checking regions
-
Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see Regions.
- Alias records
-
When you register an instance, if you include the
AWS_ALIAS_DNS_NAME
attribute, Amazon Cloud Map creates a Route 53 alias record. Note the following:-
Route 53 automatically sets
EvaluateTargetHealth
to true for alias records. WhenEvaluateTargetHealth
is true, the alias record inherits the health of the referenced Amazon resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth. -
If you include
HealthCheckConfig
and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.
-
- Charges for health checks
-
Health checks are basic Route 53 health checks that monitor an Amazon endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing
.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "FailureThreshold" :
Number
, "ResourcePath" :String
, "Type" :String
}
YAML
FailureThreshold:
Number
ResourcePath:String
Type:String
Properties
FailureThreshold
-
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
Required: No
Type: Number
Minimum:
1
Maximum:
10
Update requires: No interruption
ResourcePath
-
The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
/docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value forResourcePath
, the default value is/
.If you specify
TCP
forType
, you must not specify a value forResourcePath
.Required: No
Type: String
Maximum:
255
Update requires: No interruption
Type
-
The type of health check that you want to create, which indicates how 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 of
Type
, the endpoint must support TLS v1.0 or later. -
TCP: Route 53 tries to establish a TCP connection.
If you specify
TCP
forType
, don't specify a value forResourcePath
.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
Required: Yes
Type: String
Allowed values:
HTTP | HTTPS | TCP
Update requires: No interruption
-
See also
-
Return values in the topic AWS::ServiceDiscovery::Service
-
HealthCheckConfig in the Amazon Cloud Map API Reference