AWS AWSCloudFormation: Document Route 53 health check EndpointType and HealthCheckSourceId
Summary
Adds descriptions for the EndpointType (PUBLIC/PRIVATE) and HealthCheckSourceId properties, clarifies that private-endpoint health checks require a health check source and a private IP address, and scopes existing IP-address guidance to public health checks.
Security assessment
The added text explains public vs. private endpoint health checks and the requirement to supply a health check source and private IP for VPC endpoints. This is operational/network configuration documentation, not a security feature or a fix for a specific weakness.
Evidence
+The health check targets a private endpoint in a VPC. You must also specify `HealthCheckSourceId`. `PRIVATE` isn't supported for health checks with a `Type` of `CALCULATED`, `CLOUDWATCH_METRIC`, or `RECOVERY_CONTROL`.
Diff
diff --git a/AWSCloudFormation/latest/TemplateReference/aws-properties-route53-healthcheck-healthcheckconfig.md b/AWSCloudFormation/latest/TemplateReference/aws-properties-route53-healthcheck-healthcheckconfig.md index b4e9482..7509184 100644 --- a//AWSCloudFormation/latest/TemplateReference/aws-properties-route53-healthcheck-healthcheckconfig.md +++ b//AWSCloudFormation/latest/TemplateReference/aws-properties-route53-healthcheck-healthcheckconfig.md @@ -115 +115,15 @@ _Required_ : No -Property description not available. +Specifies whether the health check targets a public endpoint or a private endpoint in a VPC. Valid values: + +`PUBLIC` + + +The health check targets an endpoint that is reachable over the internet. This is the default. + +`PRIVATE` + + +The health check targets a private endpoint in a VPC. You must also specify `HealthCheckSourceId`. `PRIVATE` isn't supported for health checks with a `Type` of `CALCULATED`, `CLOUDWATCH_METRIC`, or `RECOVERY_CONTROL`. + +Important + +You can't change the value of `EndpointType` after you create a health check. Adding `EndpointType` to the template of an existing health check replaces the health check, so leave it unset for existing public health checks. @@ -193 +207,5 @@ _Required_ : No -Property description not available. +The ID of the health check source that Route 53 uses to send health checks to a private endpoint. Required when `EndpointType` is `PRIVATE`. + +You can change `HealthCheckSourceId` on an existing private health check. You can't add it to a public health check. + +Each health check source supports a limited number of active health checks. If you reach that limit, specify a different health check source. @@ -276 +294 @@ Use one of the following formats for the value of `IPAddress`: -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 a public health check, 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. @@ -280 +298 @@ For more information, see [FullyQualifiedDomainName](https://docs.aws.amazon.com -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: +Constraints: For a public health check (`EndpointType` of `PUBLIC`, the default), 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 public health checks, see the following documents: @@ -290,0 +309,2 @@ Constraints: Route 53 can't check the health of endpoints for which the IP addre +For a private endpoint health check (`EndpointType` of `PRIVATE`), if you specify `IPAddress`, it must be a private IPv4 or IPv6 address. Route 53 sends health checks to it from the health check source that you specify in `HealthCheckSourceId`. +