Menu
Amazon Route 53
API Reference

UpdateHealthCheck

Updates an existing health check. Note that some values can't be updated.

For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

Request Syntax

POST /2013-04-01/healthcheck/HealthCheckId HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<UpdateHealthCheckRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/">
   <AlarmIdentifier>
      <Name>string</Name>
      <Region>string</Region>
   </AlarmIdentifier>
   <ChildHealthChecks>
      <ChildHealthCheck>string</ChildHealthCheck>
   </ChildHealthChecks>
   <EnableSNI>boolean</EnableSNI>
   <FailureThreshold>integer</FailureThreshold>
   <FullyQualifiedDomainName>string</FullyQualifiedDomainName>
   <HealthCheckVersion>long</HealthCheckVersion>
   <HealthThreshold>integer</HealthThreshold>
   <InsufficientDataHealthStatus>string</InsufficientDataHealthStatus>
   <Inverted>boolean</Inverted>
   <IPAddress>string</IPAddress>
   <Port>integer</Port>
   <Regions>
      <Region>string</Region>
   </Regions>
   <ResetElements>
      <ResettableElementName>string</ResettableElementName>
   </ResetElements>
   <ResourcePath>string</ResourcePath>
   <SearchString>string</SearchString>
</UpdateHealthCheckRequest>

URI Request Parameters

The request requires the following URI parameters.

HealthCheckId

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Length Constraints: Maximum length of 64.

Request Body

The request accepts the following data in XML format.

UpdateHealthCheckRequest

Root level tag for the UpdateHealthCheckRequest parameters.

Required: Yes

AlarmIdentifier

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

Type: AlarmIdentifier object

Required: No

ChildHealthChecks

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Type: Array of strings

Array Members: Maximum number of 256 items.

Length Constraints: Maximum length of 64.

Required: No

EnableSNI

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

Type: Boolean

Required: No

FailureThreshold

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: No

FullyQualifiedDomainName

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

Note

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

Note

If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

Important

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

Type: String

Length Constraints: Maximum length of 255.

Required: No

HealthCheckVersion

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Amazon Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Amazon Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Amazon Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

Type: Long

Valid Range: Minimum value of 1.

Required: No

HealthThreshold

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 256.

Required: No

InsufficientDataHealthStatus

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Amazon Route 53 considers the health check to be healthy.

  • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Type: String

Valid Values: Healthy | Unhealthy | LastKnownStatus

Required: No

Inverted

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

Type: Boolean

Required: No

IPAddress

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

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 never changes. For more information, see the applicable documentation:

Note

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see UpdateHealthCheck:FullyQualifiedDomainName.

Constraints: Amazon 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:

Type: String

Length Constraints: Maximum length of 45.

Pattern: (^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)

Required: No

Port

The port on the endpoint on which you want Amazon Route 53 to perform health checks.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No

Regions

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Type: Array of strings

Array Members: Minimum number of 3 items. Maximum number of 64 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1

Required: No

ResetElements

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Type: Array of strings

Array Members: Maximum number of 64 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: FullyQualifiedDomainName | Regions | ResourcePath | ChildHealthChecks

Required: No

ResourcePath

The path that you want Amazon 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, for example the file /docs/route53-health-check.html.

Specify this value only if you want to change it.

Type: String

Length Constraints: Maximum length of 255.

Required: No

SearchString

If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Type: String

Length Constraints: Maximum length of 255.

Required: No

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<UpdateHealthCheckResponse>
   <HealthCheck>
      <CallerReference>string</CallerReference>
      <CloudWatchAlarmConfiguration>
         <ComparisonOperator>string</ComparisonOperator>
         <Dimensions>
            <Dimension>
               <Name>string</Name>
               <Value>string</Value>
            </Dimension>
         </Dimensions>
         <EvaluationPeriods>integer</EvaluationPeriods>
         <MetricName>string</MetricName>
         <Namespace>string</Namespace>
         <Period>integer</Period>
         <Statistic>string</Statistic>
         <Threshold>double</Threshold>
      </CloudWatchAlarmConfiguration>
      <HealthCheckConfig>
         <AlarmIdentifier>
            <Name>string</Name>
            <Region>string</Region>
         </AlarmIdentifier>
         <ChildHealthChecks>
            <ChildHealthCheck>string</ChildHealthCheck>
         </ChildHealthChecks>
         <EnableSNI>boolean</EnableSNI>
         <FailureThreshold>integer</FailureThreshold>
         <FullyQualifiedDomainName>string</FullyQualifiedDomainName>
         <HealthThreshold>integer</HealthThreshold>
         <InsufficientDataHealthStatus>string</InsufficientDataHealthStatus>
         <Inverted>boolean</Inverted>
         <IPAddress>string</IPAddress>
         <MeasureLatency>boolean</MeasureLatency>
         <Port>integer</Port>
         <Regions>
            <Region>string</Region>
         </Regions>
         <RequestInterval>integer</RequestInterval>
         <ResourcePath>string</ResourcePath>
         <SearchString>string</SearchString>
         <Type>string</Type>
      </HealthCheckConfig>
      <HealthCheckVersion>long</HealthCheckVersion>
      <Id>string</Id>
      <LinkedService>
         <Description>string</Description>
         <ServicePrincipal>string</ServicePrincipal>
      </LinkedService>
   </HealthCheck>
</UpdateHealthCheckResponse>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

UpdateHealthCheckResponse

Root level tag for the UpdateHealthCheckResponse parameters.

Required: Yes

HealthCheck

A complex type that contains information about one health check that is associated with the current AWS account.

Type: HealthCheck object

Errors

For information about the errors that are common to all actions, see Common Errors.

HealthCheckVersionMismatch

The value of HealthCheckVersion in the request doesn't match the value of HealthCheckVersion in the health check.

HTTP Status Code: 409

InvalidInput

The input is not valid.

HTTP Status Code: 400

NoSuchHealthCheck

No health check exists with the ID that you specified in the DeleteHealthCheck request.

HTTP Status Code: 404

Examples

Request Syntax for HTTP[S], HTTP[S]_STR_MATCH, and TCP Health Checks

Copy
POST /2013-04-01/healthcheck/health check ID HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateHealthCheckRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheckVersion>sequential counter</HealthCheckVersion> <IPAddress>IP address of the endpoint to check</IPAddress> <Port>port on the endpoint to check</Port> <ResourcePath>path of the file that you want Amazon Route 53 to request</ResourcePath> <FullyQualifiedDomainName>domain name of the endpoint to check</FullyQualifiedDomainName> <SearchString>if Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string to search for in the response body from the specified resource</SearchString> <FailureThreshold>number of health checks that must pass or fail to change the status of the health check</FailureThreshold> <EnableSNI>true | false</EnableSNI> <Regions> <Region>us-west-1 | us-west-2 | us-east-1 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1</Region> ... </Regions> <Inverted>true | false</Inverted> </UpdateHealthCheckRequest>

Response Syntax for HTTP[S], HTTP[S]_STR_MATCH, and TCP Health Checks

Copy
HTTP/1.1 201 Created <?xml version="1.0" encoding="UTF-8"?> <UpdateHealthCheckResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheck> <Id>ID that Amazon Route 53 assigned to the health check when you created it</Id> <CallerReference>unique description</CallerReference> <HealthCheckConfig> <IPAddress>IP address of the endpoint to check</IPAddress> <Port>port on the endpoint to check</Port> <Type>HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP</Type> <ResourcePath>path of the file that you want Amazon Route 53 to request</ResourcePath> <FullyQualifiedDomainName>domain name of the endpoint to check</FullyQualifiedDomainName> <SearchString>if Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string to search for in the response body from the specified resource</SearchString> <RequestInterval>10 | 30</RequestInterval> <FailureThreshold>number of health checks that must pass or fail to change the status of the health check</FailureThreshold> <MeasureLatency>true | false</MeasureLatency> <EnableSNI>true | false</EnableSNI> <Inverted>true | false</Inverted> </HealthCheckConfig> <HealthCheckVersion>sequential counter</HealthCheckVersion> </HealthCheck> </UpdateHealthCheckResponse>

Request Syntax for CLOUDWATCH_METRIC Health Checks

Copy
POST /2013-04-01/healthcheck/health check ID HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateHealthCheckRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheckVersion>sequential counter</HealthCheckVersion> <AlarmIdentifier> <Name>name of CloudWatch alarm</Name> <Region>region that CloudWatch alarm was created in</Region> </AlarmIdentifier> <InsufficientDataHealthStatus>Healthy | Unhealthy | LastKnownStatus</InsufficientDataHealthStatus> <Inverted>true | false</Inverted> </UpdateHealthCheckRequest>

Response Syntax for CLOUDWATCH_METRIC Health Checks

Copy
POST /2013-04-01/healthcheck HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateHealthCheckResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheck> <Id>ID that Amazon Route 53 assigned to the health check when you created it</Id> <CallerReference>unique description</CallerReference> <HealthCheckConfig> <Type>CLOUDWATCH_METRIC</Type> <AlarmIdentifier> <Name>name of CloudWatch alarm</Name> <Region>region of CloudWatch alarm</Region> </AlarmIdentifier> <InsufficientDataHealthStatus>Healthy | Unhealthy | LastKnownStatus</InsufficientDataHealthStatus> <Inverted>true | false</Inverted> </HealthCheckConfig> <CloudWatchAlarmConfiguration> <EvaluationPeriods>number of periods that metric is compared to threshold</EvaluationPeriods> <Threshold>value the metric is compared with</Threshold> <ComparisonOperator>GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold</ComparisonOperator> <Period>duration of a period in seconds</Period> <MetricName>name of the metric that's associated with the alarm</MetricName> <Namespace>namespace of the metric that the alarm is associated with</Namespace> <Statistic>statistic applied to the CloudWatch metric</Statistic> <Dimensions> <Dimension> <Name>name of a dimension for the metric</Name> <Value>value of a dimension for the metric</Value> </Dimension> ... </Dimensions> </CloudWatchAlarmConfiguration> <HealthCheckVersion>sequential counter</HealthCheckVersion> </HealthCheck> </UpdateHealthCheckResponse>

Request Syntax for CALCULATED Health Checks

Copy
POST /2013-04-01/healthcheck/health check ID HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateHealthCheckRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheckVersion>sequential counter</HealthCheckVersion> <HealthThreshold>number of health checks that are associated with a CALCULATED health check that must be healthy</HealthThreshold> <ChildHealthChecks> <ChildHealthCheck>health check ID</ChildHealthCheck> ... </ChildHealthChecks> <Inverted>true | false</Inverted> </UpdateHealthCheckRequest>

Response Syntax for CALCULATED Health Checks

Copy
HTTP/1.1 201 Created <?xml version="1.0" encoding="UTF-8"?> <UpdateHealthCheckResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HealthCheck> <Id>ID that Amazon Route 53 assigned to the health check when you created it</Id> <CallerReference>unique description</CallerReference> <HealthCheckConfig> <Type>CALCULATED</Type> <HealthThreshold>number of health checks associated with a CALCULATED health check that must be healthy</HealthThreshold> <ChildHealthChecks> <ChildHealthCheck>health check ID</ChildHealthCheck> ... </ChildHealthChecks> <Inverted>true | false</Inverted> </HealthCheckConfig> <HealthCheckVersion>sequential counter</HealthCheckVersion> </HealthCheck> </UpdateHealthCheckResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: