Interface CfnService.HealthCheckConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnService.HealthCheckConfigProperty.Jsii$Proxy
- Enclosing class:
CfnService
DnsConfig .
If you specify a health check configuration, you can specify either
HealthCheckCustomConfigorHealthCheckConfigbut not both.
Health checks are basic Route 53 health checks that monitor an AWS 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
DnsConfigincludes configurations for bothAandAAAArecords, AWS 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 theAandAAAArecords to be unhealthy. - CNAME records - You can't specify settings for
HealthCheckConfigwhen theDNSConfigincludesCNAMEfor the value ofType. If you do, theCreateServicerequest will fail with anInvalidInputerror. - Request interval - A Route 53 health checker in each health-checking AWS 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_NAMEattribute, AWS Cloud Map creates a Route 53 alias record. Note the following: - Route 53 automatically sets
EvaluateTargetHealthto true for alias records. WhenEvaluateTargetHealthis true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth . - If you include
HealthCheckConfigand 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 AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.servicediscovery.*;
HealthCheckConfigProperty healthCheckConfigProperty = HealthCheckConfigProperty.builder()
.type("type")
// the properties below are optional
.failureThreshold(123)
.resourcePath("resourcePath")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnService.HealthCheckConfigPropertystatic final classAn implementation forCfnService.HealthCheckConfigProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default NumberThe 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.default StringThe path that you want Route 53 to request when performing health checks.getType()The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getType
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.You can't change the value of
Typeafter 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.
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
TCPforType, 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 .
- See Also:
-
getFailureThreshold
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 .
- See Also:
-
getResourcePath
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
TCPforType, you must not specify a value forResourcePath.- See Also:
-
builder
-