Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . route53 ]

update-health-check

Description

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 .

See also: AWS API Documentation

Synopsis

  update-health-check
--health-check-id <value>
[--health-check-version <value>]
[--ip-address <value>]
[--port <value>]
[--resource-path <value>]
[--fully-qualified-domain-name <value>]
[--search-string <value>]
[--failure-threshold <value>]
[--inverted | --no-inverted]
[--health-threshold <value>]
[--child-health-checks <value>]
[--enable-sni | --no-enable-sni]
[--regions <value>]
[--alarm-identifier <value>]
[--insufficient-data-health-status <value>]
[--reset-elements <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--health-check-id (string)

The ID for the health check for which you want detailed information. When you created the health check, create-health-check returned the ID in the response, in the health-check-id element.

--health-check-version (long)

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 get-health-check or list-health-checks to get the current value of health-check-version for the health check that you want to update, and that you include that value in your update-health-check request. This prevents Amazon Route 53 from overwriting an intervening update:

  • If the value in the update-health-check request matches the value of health-check-version in the health check, Amazon Route 53 updates the health check with the new settings.
  • If the value of health-check-version 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.

--ip-address (string)

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 ip-address , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in fully-qualified-domain-name 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 ip-address :

  • 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 ip-address . 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 ip-address , you can change the value. However, you can't update an existing health check to add or remove the value of ip-address .

For more information, see UpdateHealthCheckRequest$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:

--port (integer)

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

--resource-path (string)

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.

--fully-qualified-domain-name (string)

Amazon Route 53 behavior depends on whether you specify a value for ip-address .

Note

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

If you specify a value for ip-address :

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of fully-qualified-domain-name 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 fully-qualified-domain-name 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 fully-qualified-domain-name 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 * fully-qualified-domain-name :port * to the endpoint in the Host header.

If you don't specify a value for fully-qualified-domain-name , Amazon Route 53 substitutes the value of ip-address in the Host header in each of the above cases.

If you don't specify a value for ip-address :

If you don't specify a value for ip-address , Amazon Route 53 sends a DNS request to the domain that you specify in fully-qualified-domain-name 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 ip-address , 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 fully-qualified-domain-name , 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 fully-qualified-domain-name , 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 fully-qualified-domain-name , 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).

Warning

In this configuration, if the value of fully-qualified-domain-name 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 fully-qualified-domain-name in the Host header, as it does when you specify a value for ip-address . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.

--search-string (string)

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.)

--failure-threshold (integer)

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 failure-threshold , the default value is three health checks.

--inverted | --no-inverted (boolean)

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.

--health-threshold (integer)

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.

--child-health-checks (list)

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

Syntax:

"string" "string" ...

--enable-sni | --no-enable-sni (boolean)

Specify whether you want Amazon Route 53 to send the value of fully-qualified-domain-name 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 fully-qualified-domain-name . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in fully-qualified-domain-name , a health checker will retry the handshake. In the second attempt, the health checker will omit fully-qualified-domain-name from the client_hello message.

--regions (list)

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.

Syntax:

"string" "string" ...

Where valid values are:
  us-east-1
  us-west-1
  us-west-2
  eu-west-1
  ap-southeast-1
  ap-southeast-2
  ap-northeast-1
  sa-east-1

--alarm-identifier (structure)

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.

Shorthand Syntax:

Region=string,Name=string

JSON Syntax:

{
  "Region": "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"ca-central-1"|"eu-central-1"|"eu-west-1"|"eu-west-2"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"sa-east-1",
  "Name": "string"
}

--insufficient-data-health-status (string)

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.

Possible values:

  • Healthy
  • Unhealthy
  • LastKnownStatus

--reset-elements (list)

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:

  • ChildHealthChecks : Amazon Route 53 resets HealthCheckConfig$ChildHealthChecks to null.
  • fully-qualified-domain-name : Amazon Route 53 resets HealthCheckConfig$FullyQualifiedDomainName to null.
  • Regions : Amazon Route 53 resets the HealthCheckConfig$Regions list to the default set of regions.
  • resource-path : Amazon Route 53 resets HealthCheckConfig$ResourcePath to null.

Syntax:

"string" "string" ...

Where valid values are:
  FullyQualifiedDomainName
  Regions
  ResourcePath
  ChildHealthChecks

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

HealthCheck -> (structure)

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

Id -> (string)

The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

CallerReference -> (string)

A unique string that you specified when you created the health check.

LinkedService -> (structure)

If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.

ServicePrincipal -> (string)

If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

Description -> (string)

If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

HealthCheckConfig -> (structure)

A complex type that contains detailed information about one health check.

IPAddress -> (string)

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

Use one of the following formats for the value of ip-address :

  • 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 ip-address . This ensures that the IP address of your instance will never change.

For more information, see HealthCheckConfig$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:

When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit ip-address .

Port -> (integer)

The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for port only when you specify a value for ip-address .

Type -> (string)

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

Warning

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
  • HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

Warning

If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.

  • HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in search-string .
  • HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in search-string .
  • TCP : Amazon Route 53 tries to establish a TCP connection.
  • CLOUDWATCH_METRIC : The health check is associated with a CloudWatch alarm. If the state of the alarm is OK , the health check is considered healthy. If the state is ALARM , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM , the health check status depends on the setting for insufficient-data-health-status : Healthy , Unhealthy , or LastKnownStatus .
  • CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of health-threshold .

For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .

ResourcePath -> (string)

The path, if any, 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.

FullyQualifiedDomainName -> (string)

Amazon Route 53 behavior depends on whether you specify a value for ip-address .

If you specify a value for ip-address :

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of fully-qualified-domain-name 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 fully-qualified-domain-name 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 fully-qualified-domain-name 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 fully-qualified-domain-name , Amazon Route 53 substitutes the value of ip-address in the Host header in each of the preceding cases.

**If you don't specify a value for ip-address ** :

Amazon Route 53 sends a DNS request to the domain that you specify for fully-qualified-domain-name at the interval that you specify for RequestInterval . Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

Note

If you don't specify a value for ip-address , 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 fully-qualified-domain-name , 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 fully-qualified-domain-name , 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 fully-qualified-domain-name , 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).

Warning

In this configuration, if you create a health check for which the value of fully-qualified-domain-name 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 that you specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of fully-qualified-domain-name in the Host header, as it does when you specify a value for ip-address . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.

SearchString -> (string)

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.

Amazon Route 53 considers case when searching for search-string in the response body.

RequestInterval -> (integer)

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at this interval.

Warning

You can't change the value of RequestInterval after you create a health check.

If you don't specify a value for RequestInterval , the default value is 30 seconds.

FailureThreshold -> (integer)

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 failure-threshold , the default value is three health checks.

MeasureLatency -> (boolean)

Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

Warning

You can't change the value of MeasureLatency after you create a health check.

Inverted -> (boolean)

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.

HealthThreshold -> (integer)

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 HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks 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.

ChildHealthChecks -> (list)

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

(string)

EnableSNI -> (boolean)

Specify whether you want Amazon Route 53 to send the value of fully-qualified-domain-name 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 fully-qualified-domain-name . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in fully-qualified-domain-name , a health checker will retry the handshake. In the second attempt, the health checker will omit fully-qualified-domain-name from the client_hello message.

Regions -> (list)

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

If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values .

If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

(string)

AlarmIdentifier -> (structure)

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.

Region -> (string)

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.

For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .

Name -> (string)

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

InsufficientDataHealthStatus -> (string)

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 that 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.

HealthCheckVersion -> (long)

The version of the health check. You can optionally pass this value in a call to update-health-check to prevent overwriting another change to the health check.

CloudWatchAlarmConfiguration -> (structure)

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

EvaluationPeriods -> (integer)

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

Threshold -> (double)

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

ComparisonOperator -> (string)

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

Period -> (integer)

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

MetricName -> (string)

The name of the CloudWatch metric that the alarm is associated with.

Namespace -> (string)

The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .

Statistic -> (string)

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

Dimensions -> (list)

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .

(structure)

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.

Name -> (string)

For the metric that the CloudWatch alarm is associated with, the name of one dimension.

Value -> (string)

For the metric that the CloudWatch alarm is associated with, the value of one dimension.