Class UpdateHealthCheckRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.route53.model.Route53Request
software.amazon.awssdk.services.route53.model.UpdateHealthCheckRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateHealthCheckRequest.Builder,UpdateHealthCheckRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateHealthCheckRequest extends Route53Request implements ToCopyableBuilder<UpdateHealthCheckRequest.Builder,UpdateHealthCheckRequest>

A complex type that contains information about a request to update a health check.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    UpdateHealthCheckRequest.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final AlarmIdentifier
    alarmIdentifier()
    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.
    static UpdateHealthCheckRequest.Builder
    builder()
     
    final List<String>
    childHealthChecks()
    A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.
    final Boolean
    disabled()
    Stops Route 53 from performing health checks.
    final Boolean
    enableSNI()
    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation.
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final Integer
    failureThreshold()
    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
    final String
    fullyQualifiedDomainName()
    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
    Used to retrieve the value of a field from any class that extends SdkRequest.
    final boolean
    hasChildHealthChecks()
    For responses, this returns true if the service returned a value for the ChildHealthChecks property.
    final int
    hashCode()
     
    final boolean
    hasRegions()
    For responses, this returns true if the service returned a value for the Regions property.
    final boolean
    hasResetElements()
    For responses, this returns true if the service returned a value for the ResetElements property.
    final String
    healthCheckId()
    The ID for the health check for which you want detailed information.
    final Long
    healthCheckVersion()
    A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.
    final Integer
    healthThreshold()
    The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy.
    final InsufficientDataHealthStatus
    insufficientDataHealthStatus()
    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
    final String
    insufficientDataHealthStatusAsString()
    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:
    final Boolean
    inverted()
    Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
    final String
    ipAddress()
    The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on.
    final Integer
    port()
    The port on the endpoint that you want Amazon Route 53 to perform health checks on.
    final List<HealthCheckRegion>
    regions()
    A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.
    final List<String>
    regionsAsStrings()
    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.
    final List<ResettableElementName>
    resetElements()
    A complex type that contains one ResettableElementName element for each element that you want to reset to the default value.
    final List<String>
    resetElementsAsStrings()
    A complex type that contains one ResettableElementName element for each element that you want to reset to the default value.
    final String
    resourcePath()
    The path that you want Amazon Route 53 to request when performing health checks.
    final List<SdkField<?>>
    sdkFields()
     
    final String
    searchString()
    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.
    static Class<? extends UpdateHealthCheckRequest.Builder>
    serializableBuilderClass()
     
    UpdateHealthCheckRequest.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.

    Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

    overrideConfiguration

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

    copy

  • Method Details

    • healthCheckId

      public final String healthCheckId()

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

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

    • healthCheckVersion

      public final Long healthCheckVersion()

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

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

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

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

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

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

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

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

    • ipAddress

      public final String ipAddress()

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

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

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

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

      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

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

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

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

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

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

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

      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

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

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

    • port

      public final Integer port()

      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.

      Returns:
      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.

    • resourcePath

      public final String resourcePath()

      The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

      Specify this value only if you want to change it.

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

      Specify this value only if you want to change it.

    • fullyQualifiedDomainName

      public final String fullyQualifiedDomainName()

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

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

      If you specify a value for IPAddress:

      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 above cases.

      If you don't specify a value for IPAddress:

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

      If you don't specify a value for IPAddress, you can’t update the health check to remove the FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a FullyQualifiedDomainName is required.

      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 resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

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

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

      In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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.

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

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

      If you specify a value for IPAddress:

      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 above cases.

      If you don't specify a value for IPAddress:

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

      If you don't specify a value for IPAddress, you can’t update the health check to remove the FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a FullyQualifiedDomainName is required.

      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 resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

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

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

      In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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.

    • searchString

      public final String searchString()

      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. (You can't change the value of Type when you update a health check.)

      Returns:
      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. (You can't change the value of Type when you update a health check.)

    • failureThreshold

      public final Integer failureThreshold()

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

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

      Returns:
      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.

    • inverted

      public final Boolean inverted()

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

      Returns:
      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.

    • disabled

      public final Boolean disabled()

      Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

      • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

      • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

      • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

      After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

      Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

      Returns:
      Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

      • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

      • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

      • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

      After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

      Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

    • healthThreshold

      public final Integer healthThreshold()

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

      Note the following:

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

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

      Returns:
      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, Route 53 always considers this health check to be unhealthy.

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

    • hasChildHealthChecks

      public final boolean hasChildHealthChecks()
      For responses, this returns true if the service returned a value for the ChildHealthChecks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • childHealthChecks

      public final List<String> childHealthChecks()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChildHealthChecks() method.

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

    • enableSNI

      public final Boolean enableSNI()

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

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

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

      Returns:
      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.

    • regions

      public final List<HealthCheckRegion> regions()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegions() method.

      Returns:
      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.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • regionsAsStrings

      public final List<String> regionsAsStrings()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegions() method.

      Returns:
      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.

    • alarmIdentifier

      public final AlarmIdentifier alarmIdentifier()

      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.

      Returns:
      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.

    • insufficientDataHealthStatus

      public final InsufficientDataHealthStatus insufficientDataHealthStatus()

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

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

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

      • LastKnownStatus: By default, 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 status for the health check is healthy.

      If the service returns an enum value that is not available in the current SDK version, insufficientDataHealthStatus will return InsufficientDataHealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from insufficientDataHealthStatusAsString().

      Returns:
      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: By default, 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 status for the health check is healthy.

      See Also:

    • insufficientDataHealthStatusAsString

      public final String insufficientDataHealthStatusAsString()

      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: By default, 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 status for the health check is healthy.

      If the service returns an enum value that is not available in the current SDK version, insufficientDataHealthStatus will return InsufficientDataHealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from insufficientDataHealthStatusAsString().

      Returns:
      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: By default, 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 status for the health check is healthy.

      See Also:

    • resetElements

      public final List<ResettableElementName> resetElements()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResetElements() method.

      Returns:
      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:

    • hasResetElements

      public final boolean hasResetElements()
      For responses, this returns true if the service returned a value for the ResetElements property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resetElementsAsStrings

      public final List<String> resetElementsAsStrings()

      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:

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResetElements() method.

      Returns:
      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:

    • toBuilder

      public UpdateHealthCheckRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateHealthCheckRequest.Builder,UpdateHealthCheckRequest>
      Specified by:
      toBuilder in class Route53Request
      Returns:
      a builder for type T

    • builder

      public static UpdateHealthCheckRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateHealthCheckRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.