Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::Route53::HealthCheck

Use the AWS::Route53::HealthCheck resource to check the health of your resources before Amazon Route 53 responds to a DNS query. For more information, see How Health Checks Work in Simple Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.

Syntax

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

JSON

Copy
{ "Type" : "AWS::Route53::HealthCheck", "Properties" : { "HealthCheckConfig" : HealthCheckConfig, "HealthCheckTags" : [ HealthCheckTags, ... ] } }

YAML

Copy
Type: "AWS::Route53::HealthCheck" Properties: HealthCheckConfig: HealthCheckConfig HealthCheckTags: - HealthCheckTags

Properties

HealthCheckConfig

An Amazon Route 53 health check.

Required: Yes

Type: Amazon Route 53 HealthCheckConfig

Update requires: No interruption

HealthCheckTags

An arbitrary set of tags (key–value pairs) for this health check.

Required: No

Type: A list of Amazon Route 53 HealthCheckTags

Update requires: No interruption

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the health check ID, such as e0a123b4-4dba-4650-935e-example.

For more information about using the Ref function, see Ref.

Example

The following example creates an Amazon Route 53 health check that sends request to the specified endpoint.

JSON

Copy
"myHealthCheck": { "Type": "AWS::Route53::HealthCheck", "Properties": { "HealthCheckConfig": { "IPAddress": "000.000.000.000", "Port": "80", "Type": "HTTP", "ResourcePath": "/example/index.html", "FullyQualifiedDomainName": "example.com", "RequestInterval": "30", "FailureThreshold": "3" }, "HealthCheckTags" : [{ "Key": "SampleKey1", "Value": "SampleValue1" }, { "Key": "SampleKey2", "Value": "SampleValue2" }] } }

YAML

Copy
myHealthCheck: Type: "AWS::Route53::HealthCheck" Properties: HealthCheckConfig: IPAddress: "000.000.000.000" Port: "80" Type: "HTTP" ResourcePath: "/example/index.html" FullyQualifiedDomainName: "example.com" RequestInterval: "30" FailureThreshold: "3" HealthCheckTags: - Key: "SampleKey1" Value: "SampleValue1" - Key: "SampleKey2" Value: "SampleValue2"