AWS Documentation » AWS CloudFormation » User Guide » Template Reference » Resource Property Types Reference » Amazon Route 53 ServiceDiscovery HealthCheckConfig

Filter View: All JSON YAML

Amazon Route 53 ServiceDiscovery HealthCheckConfig

The HealthCheckConfig property type specifies settings for an optional Amazon Route 53 health check. If you specify settings for a health check, Route 53 associates the health check with all the resource record sets that you specify in DnsConfig.

HealthCheckConfig is a property of the AWS::ServiceDiscovery::Service resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : String,
  "ResourcePath" : String,
  "FailureThreshold" : Double
}

YAML

Type: String
ResourcePath: String
FailureThreshold: Double

Properties

Type

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid types include HTTP, HTTPS, and TCP.

Required: Yes

Type: String

Update requires: No interruption

ResourcePath

The path that you want 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. Route 53 automatically adds the DNS name for the service and a leading forward slash (/) character.

Required: No

Type: String

Update requires: No interruption

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 vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide

Required: No

Type: Double

Update requires: No interruption

See Also

• Using Autonaming for Service Discovery in the Amazon Route 53 API Reference

• CreateService in the Amazon Route 53 API Reference