1. Packages
  2. AWS Native
  3. API Docs
  4. route53
  5. getHealthCheck

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.route53.getHealthCheck

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Resource schema for AWS::Route53::HealthCheck.

    Using getHealthCheck

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHealthCheck(args: GetHealthCheckArgs, opts?: InvokeOptions): Promise<GetHealthCheckResult>
    function getHealthCheckOutput(args: GetHealthCheckOutputArgs, opts?: InvokeOptions): Output<GetHealthCheckResult>
    def get_health_check(health_check_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetHealthCheckResult
    def get_health_check_output(health_check_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetHealthCheckResult]
    func LookupHealthCheck(ctx *Context, args *LookupHealthCheckArgs, opts ...InvokeOption) (*LookupHealthCheckResult, error)
    func LookupHealthCheckOutput(ctx *Context, args *LookupHealthCheckOutputArgs, opts ...InvokeOption) LookupHealthCheckResultOutput

    > Note: This function is named LookupHealthCheck in the Go SDK.

    public static class GetHealthCheck 
    {
        public static Task<GetHealthCheckResult> InvokeAsync(GetHealthCheckArgs args, InvokeOptions? opts = null)
        public static Output<GetHealthCheckResult> Invoke(GetHealthCheckInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHealthCheckResult> getHealthCheck(GetHealthCheckArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:route53:getHealthCheck
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HealthCheckId string
    The identifier that Amazon Route 53 assigned 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.
    HealthCheckId string
    The identifier that Amazon Route 53 assigned 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.
    healthCheckId String
    The identifier that Amazon Route 53 assigned 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.
    healthCheckId string
    The identifier that Amazon Route 53 assigned 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.
    health_check_id str
    The identifier that Amazon Route 53 assigned 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.
    healthCheckId String
    The identifier that Amazon Route 53 assigned 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.

    getHealthCheck Result

    The following output properties are available:

    HealthCheckConfig Pulumi.AwsNative.Route53.Outputs.HealthCheckConfigProperties
    A complex type that contains information about the health check.
    HealthCheckId string
    The identifier that Amazon Route 53 assigned 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.
    HealthCheckTags List<Pulumi.AwsNative.Route53.Outputs.HealthCheckTag>
    An array of key-value pairs to apply to this resource.
    HealthCheckConfig HealthCheckConfigProperties
    A complex type that contains information about the health check.
    HealthCheckId string
    The identifier that Amazon Route 53 assigned 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.
    HealthCheckTags []HealthCheckTag
    An array of key-value pairs to apply to this resource.
    healthCheckConfig HealthCheckConfigProperties
    A complex type that contains information about the health check.
    healthCheckId String
    The identifier that Amazon Route 53 assigned 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.
    healthCheckTags List<HealthCheckTag>
    An array of key-value pairs to apply to this resource.
    healthCheckConfig HealthCheckConfigProperties
    A complex type that contains information about the health check.
    healthCheckId string
    The identifier that Amazon Route 53 assigned 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.
    healthCheckTags HealthCheckTag[]
    An array of key-value pairs to apply to this resource.
    health_check_config HealthCheckConfigProperties
    A complex type that contains information about the health check.
    health_check_id str
    The identifier that Amazon Route 53 assigned 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.
    health_check_tags Sequence[HealthCheckTag]
    An array of key-value pairs to apply to this resource.
    healthCheckConfig Property Map
    A complex type that contains information about the health check.
    healthCheckId String
    The identifier that Amazon Route 53 assigned 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.
    healthCheckTags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    HealthCheckAlarmIdentifier

    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.
    Region string
    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
    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.
    Region string
    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
    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.
    region String
    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
    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.
    region string
    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
    name str
    The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
    region str
    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
    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.
    region String
    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

    HealthCheckConfigProperties

    Type Pulumi.AwsNative.Route53.HealthCheckConfigPropertiesType

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

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

    You can create the following types of health checks:

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

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

    • HTTP_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • HTTPS_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • TCP : 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 InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • CALCULATED : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
    • RECOVERY_CONTROL : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON , the health check is considered healthy. If the state is OFF , the health check is considered unhealthy.

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

    AlarmIdentifier Pulumi.AwsNative.Route53.Inputs.HealthCheckAlarmIdentifier
    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
    ChildHealthChecks List<string>
    (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.
    EnableSni bool

    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.

    FailureThreshold int

    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.

    FullyQualifiedDomainName string

    Amazon Route 53 behavior depends on whether you specify a value for 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 Route 53 to perform health checks.

    When 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 , 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 , 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 , Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

    If you don't specify a value for IPAddress :

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

    If you don't specify a value for IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record 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 multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, 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 , 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 , Route 53 doesn't pass a Host header.

    HealthThreshold int

    The number of child health checks that are associated with a CALCULATED health check 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 element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
    • If you specify 0 , Route 53 always considers this health check to be healthy.
    InsufficientDataHealthStatus Pulumi.AwsNative.Route53.HealthCheckConfigPropertiesInsufficientDataHealthStatus
    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 : Route 53 considers the health check to be healthy.
    • Unhealthy : Route 53 considers the health check to be unhealthy.
    • LastKnownStatus : 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.
    Inverted bool
    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.
    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 IPAddress , 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 returned by DNS, 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 will never change.

    For more information, see FullyQualifiedDomainName .

    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:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .

    MeasureLatency bool

    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 Route 53 console.

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

    Port int

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

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED .

    Regions List<string>

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

    RequestInterval int

    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 Route 53 health checker makes requests at this interval.

    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.

    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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y .
    RoutingControlArn string

    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

    For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide. .

    SearchString string

    If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    Type HealthCheckConfigPropertiesType

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

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

    You can create the following types of health checks:

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

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

    • HTTP_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • HTTPS_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • TCP : 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 InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • CALCULATED : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
    • RECOVERY_CONTROL : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON , the health check is considered healthy. If the state is OFF , the health check is considered unhealthy.

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

    AlarmIdentifier HealthCheckAlarmIdentifier
    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
    ChildHealthChecks []string
    (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.
    EnableSni bool

    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.

    FailureThreshold int

    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.

    FullyQualifiedDomainName string

    Amazon Route 53 behavior depends on whether you specify a value for 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 Route 53 to perform health checks.

    When 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 , 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 , 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 , Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

    If you don't specify a value for IPAddress :

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

    If you don't specify a value for IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record 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 multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, 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 , 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 , Route 53 doesn't pass a Host header.

    HealthThreshold int

    The number of child health checks that are associated with a CALCULATED health check 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 element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
    • If you specify 0 , Route 53 always considers this health check to be healthy.
    InsufficientDataHealthStatus HealthCheckConfigPropertiesInsufficientDataHealthStatus
    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 : Route 53 considers the health check to be healthy.
    • Unhealthy : Route 53 considers the health check to be unhealthy.
    • LastKnownStatus : 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.
    Inverted bool
    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.
    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 IPAddress , 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 returned by DNS, 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 will never change.

    For more information, see FullyQualifiedDomainName .

    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:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .

    MeasureLatency bool

    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 Route 53 console.

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

    Port int

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

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED .

    Regions []string

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

    RequestInterval int

    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 Route 53 health checker makes requests at this interval.

    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.

    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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y .
    RoutingControlArn string

    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

    For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide. .

    SearchString string

    If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    type HealthCheckConfigPropertiesType

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

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

    You can create the following types of health checks:

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

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

    • HTTP_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • HTTPS_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • TCP : 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 InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • CALCULATED : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
    • RECOVERY_CONTROL : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON , the health check is considered healthy. If the state is OFF , the health check is considered unhealthy.

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

    alarmIdentifier HealthCheckAlarmIdentifier
    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
    childHealthChecks List<String>
    (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.
    enableSni Boolean

    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.

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

    fullyQualifiedDomainName String

    Amazon Route 53 behavior depends on whether you specify a value for 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 Route 53 to perform health checks.

    When 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 , 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 , 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 , Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

    If you don't specify a value for IPAddress :

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

    If you don't specify a value for IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record 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 multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, 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 , 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 , Route 53 doesn't pass a Host header.

    healthThreshold Integer

    The number of child health checks that are associated with a CALCULATED health check 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 element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
    • If you specify 0 , Route 53 always considers this health check to be healthy.
    insufficientDataHealthStatus HealthCheckConfigPropertiesInsufficientDataHealthStatus
    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 : Route 53 considers the health check to be healthy.
    • Unhealthy : Route 53 considers the health check to be unhealthy.
    • LastKnownStatus : 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.
    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.
    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 IPAddress , 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 returned by DNS, 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 will never change.

    For more information, see FullyQualifiedDomainName .

    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:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .

    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 Route 53 console.

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

    port Integer

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

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED .

    regions List<String>

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

    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 Route 53 health checker makes requests at this interval.

    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.

    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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y .
    routingControlArn String

    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

    For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide. .

    searchString String

    If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    type HealthCheckConfigPropertiesType

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

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

    You can create the following types of health checks:

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

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

    • HTTP_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • HTTPS_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • TCP : 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 InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • CALCULATED : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
    • RECOVERY_CONTROL : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON , the health check is considered healthy. If the state is OFF , the health check is considered unhealthy.

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

    alarmIdentifier HealthCheckAlarmIdentifier
    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
    childHealthChecks string[]
    (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.
    enableSni boolean

    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.

    failureThreshold number

    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.

    fullyQualifiedDomainName string

    Amazon Route 53 behavior depends on whether you specify a value for 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 Route 53 to perform health checks.

    When 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 , 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 , 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 , Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

    If you don't specify a value for IPAddress :

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

    If you don't specify a value for IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record 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 multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, 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 , 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 , Route 53 doesn't pass a Host header.

    healthThreshold number

    The number of child health checks that are associated with a CALCULATED health check 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 element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
    • If you specify 0 , Route 53 always considers this health check to be healthy.
    insufficientDataHealthStatus HealthCheckConfigPropertiesInsufficientDataHealthStatus
    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 : Route 53 considers the health check to be healthy.
    • Unhealthy : Route 53 considers the health check to be unhealthy.
    • LastKnownStatus : 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.
    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.
    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 IPAddress , 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 returned by DNS, 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 will never change.

    For more information, see FullyQualifiedDomainName .

    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:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .

    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 Route 53 console.

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

    port number

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

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED .

    regions string[]

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

    requestInterval number

    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 Route 53 health checker makes requests at this interval.

    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.

    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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y .
    routingControlArn string

    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

    For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide. .

    searchString string

    If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    type HealthCheckConfigPropertiesType

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

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

    You can create the following types of health checks:

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

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

    • HTTP_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • HTTPS_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • TCP : 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 InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • CALCULATED : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
    • RECOVERY_CONTROL : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON , the health check is considered healthy. If the state is OFF , the health check is considered unhealthy.

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

    alarm_identifier HealthCheckAlarmIdentifier
    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
    child_health_checks Sequence[str]
    (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.
    enable_sni bool

    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.

    failure_threshold int

    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.

    fully_qualified_domain_name str

    Amazon Route 53 behavior depends on whether you specify a value for 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 Route 53 to perform health checks.

    When 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 , 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 , 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 , Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

    If you don't specify a value for IPAddress :

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

    If you don't specify a value for IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record 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 multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, 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 , 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 , Route 53 doesn't pass a Host header.

    health_threshold int

    The number of child health checks that are associated with a CALCULATED health check 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 element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
    • If you specify 0 , Route 53 always considers this health check to be healthy.
    insufficient_data_health_status HealthCheckConfigPropertiesInsufficientDataHealthStatus
    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 : Route 53 considers the health check to be healthy.
    • Unhealthy : Route 53 considers the health check to be unhealthy.
    • LastKnownStatus : 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.
    inverted bool
    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.
    ip_address str

    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 IPAddress , 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 returned by DNS, 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 will never change.

    For more information, see FullyQualifiedDomainName .

    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:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .

    measure_latency bool

    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 Route 53 console.

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

    port int

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

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED .

    regions Sequence[str]

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

    request_interval int

    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 Route 53 health checker makes requests at this interval.

    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.

    resource_path str
    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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y .
    routing_control_arn str

    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

    For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide. .

    search_string str

    If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    type "CALCULATED" | "CLOUDWATCH_METRIC" | "HTTP" | "HTTP_STR_MATCH" | "HTTPS" | "HTTPS_STR_MATCH" | "TCP" | "RECOVERY_CONTROL"

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

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

    You can create the following types of health checks:

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

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

    • HTTP_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • HTTPS_STR_MATCH : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
    • TCP : 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 InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • CALCULATED : For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
    • RECOVERY_CONTROL : The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON , the health check is considered healthy. If the state is OFF , the health check is considered unhealthy.

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

    alarmIdentifier Property Map
    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
    childHealthChecks List<String>
    (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.
    enableSni Boolean

    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.

    failureThreshold Number

    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.

    fullyQualifiedDomainName String

    Amazon Route 53 behavior depends on whether you specify a value for 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 Route 53 to perform health checks.

    When 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 , 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 , 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 , Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

    If you don't specify a value for IPAddress :

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

    If you don't specify a value for IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If there's no record 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 multiple records that have the same name and type, such as multiple weighted records, and if 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 records (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the records and you then associate the health check with those records, 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 , 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 , Route 53 doesn't pass a Host header.

    healthThreshold Number

    The number of child health checks that are associated with a CALCULATED health check 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 element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
    • If you specify 0 , Route 53 always considers this health check to be healthy.
    insufficientDataHealthStatus "Healthy" | "LastKnownStatus" | "Unhealthy"
    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 : Route 53 considers the health check to be healthy.
    • Unhealthy : Route 53 considers the health check to be unhealthy.
    • LastKnownStatus : 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.
    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.
    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 IPAddress , 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 returned by DNS, 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 will never change.

    For more information, see FullyQualifiedDomainName .

    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:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .

    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 Route 53 console.

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

    port Number

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

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED .

    regions List<String>

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

    requestInterval Number

    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 Route 53 health checker makes requests at this interval.

    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.

    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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y .
    routingControlArn String

    The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

    For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide. .

    searchString String

    If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    HealthCheckConfigPropertiesInsufficientDataHealthStatus

    HealthCheckConfigPropertiesType

    HealthCheckTag

    Key string
    The key name of the tag.
    Value string
    The value for the tag.
    Key string
    The key name of the tag.
    Value string
    The value for the tag.
    key String
    The key name of the tag.
    value String
    The value for the tag.
    key string
    The key name of the tag.
    value string
    The value for the tag.
    key str
    The key name of the tag.
    value str
    The value for the tag.
    key String
    The key name of the tag.
    value String
    The value for the tag.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi