Interface UpdateHealthCheckRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<UpdateHealthCheckRequest.Builder,,UpdateHealthCheckRequest> Route53Request.Builder,SdkBuilder<UpdateHealthCheckRequest.Builder,,UpdateHealthCheckRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateHealthCheckRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault UpdateHealthCheckRequest.BuilderalarmIdentifier(Consumer<AlarmIdentifier.Builder> 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.alarmIdentifier(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.childHealthChecks(String... childHealthChecks) A complex type that contains oneChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.childHealthChecks(Collection<String> childHealthChecks) A complex type that contains oneChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.Stops Route 53 from performing health checks.Specify whether you want Amazon Route 53 to send the value ofFullyQualifiedDomainNameto the endpoint in theclient_hellomessage duringTLSnegotiation.failureThreshold(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.fullyQualifiedDomainName(String fullyQualifiedDomainName) Amazon Route 53 behavior depends on whether you specify a value forIPAddress.healthCheckId(String healthCheckId) The ID for the health check for which you want detailed information.healthCheckVersion(Long healthCheckVersion) A sequential counter that Amazon Route 53 sets to1when you create a health check and increments by 1 each time you update settings for the health check.healthThreshold(Integer healthThreshold) The number of child health checks that are associated with aCALCULATEDhealth that Amazon Route 53 must consider healthy for theCALCULATEDhealth check to be considered healthy.insufficientDataHealthStatus(String 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:insufficientDataHealthStatus(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: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.The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The port on the endpoint that you want Amazon Route 53 to perform health checks on.regions(Collection<HealthCheckRegion> regions) A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.regions(HealthCheckRegion... regions) A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.regionsWithStrings(String... regions) A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.regionsWithStrings(Collection<String> regions) A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.resetElements(Collection<ResettableElementName> resetElements) A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value.resetElements(ResettableElementName... resetElements) A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value.resetElementsWithStrings(String... resetElements) A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value.resetElementsWithStrings(Collection<String> resetElements) A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value.resourcePath(String resourcePath) The path that you want Amazon Route 53 to request when performing health checks.searchString(String searchString) If the value ofTypeisHTTP_STR_MATCHorHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.route53.model.Route53Request.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
healthCheckId
The ID for the health check for which you want detailed information. When you created the health check,
CreateHealthCheckreturned the ID in the response, in theHealthCheckIdelement.- Parameters:
healthCheckId- The ID for the health check for which you want detailed information. When you created the health check,CreateHealthCheckreturned the ID in the response, in theHealthCheckIdelement.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckVersion
A sequential counter that Amazon Route 53 sets to
1when you create a health check and increments by 1 each time you update settings for the health check.We recommend that you use
GetHealthCheckorListHealthChecksto get the current value ofHealthCheckVersionfor the health check that you want to update, and that you include that value in yourUpdateHealthCheckrequest. This prevents Route 53 from overwriting an intervening update:-
If the value in the
UpdateHealthCheckrequest matches the value ofHealthCheckVersionin the health check, Route 53 updates the health check with the new settings. -
If the value of
HealthCheckVersionin 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 aHealthCheckVersionMismatcherror.
- Parameters:
healthCheckVersion- A sequential counter that Amazon Route 53 sets to1when you create a health check and increments by 1 each time you update settings for the health check.We recommend that you use
GetHealthCheckorListHealthChecksto get the current value ofHealthCheckVersionfor the health check that you want to update, and that you include that value in yourUpdateHealthCheckrequest. This prevents Route 53 from overwriting an intervening update:-
If the value in the
UpdateHealthCheckrequest matches the value ofHealthCheckVersionin the health check, Route 53 updates the health check with the new settings. -
If the value of
HealthCheckVersionin 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 aHealthCheckVersionMismatcherror.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 inFullyQualifiedDomainNameat the interval that you specify inRequestInterval. 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:-
Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances
-
Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances
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 ofIPAddress.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:
- Parameters:
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 forIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify inFullyQualifiedDomainNameat the interval that you specify inRequestInterval. 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:-
Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances
-
Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances
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 ofIPAddress.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:
- Returns a reference to this object so that method calls can be chained together.
-
-
port
The port on the endpoint that you want Amazon Route 53 to perform health checks on.
Don't specify a value for
Portwhen you specify a value forTypeofCLOUDWATCH_METRICorCALCULATED.- Parameters:
port- The port on the endpoint that you want Amazon Route 53 to perform health checks on.Don't specify a value for
Portwhen you specify a value forTypeofCLOUDWATCH_METRICorCALCULATED.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofIPAddress.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
FullyQualifiedDomainNamein theHostheader 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
Hostheader:-
If you specify a value of
80forPortandHTTPorHTTP_STR_MATCHforType, Route 53 passes the value ofFullyQualifiedDomainNameto the endpoint in theHostheader. -
If you specify a value of
443forPortandHTTPSorHTTPS_STR_MATCHforType, Route 53 passes the value ofFullyQualifiedDomainNameto the endpoint in theHostheader. -
If you specify another value for
Portand any value exceptTCPforType, Route 53 passesFullyQualifiedDomainName:Portto the endpoint in theHostheader.
If you don't specify a value for
FullyQualifiedDomainName, Route 53 substitutes the value ofIPAddressin theHostheader 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 inFullyQualifiedDomainNameat the interval you specify inRequestInterval. 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 theFullyQualifiedDomainName; if you don’t specify a value forIPAddresson creation, aFullyQualifiedDomainNameis 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 forFullyQualifiedDomainName, 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 ofFullyQualifiedDomainName, specify the domain name of the server (such asus-east-2-www.example.com), not the name of the resource record sets (www.example.com).In this configuration, if the value of
FullyQualifiedDomainNamematches 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
TypeisHTTP,HTTPS,HTTP_STR_MATCH, orHTTPS_STR_MATCH, Route 53 passes the value ofFullyQualifiedDomainNamein theHostheader, as it does when you specify a value forIPAddress. If the value ofTypeisTCP, Route 53 doesn't pass aHostheader.- Parameters:
fullyQualifiedDomainName- Amazon Route 53 behavior depends on whether you specify a value forIPAddress.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 ofIPAddress.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
FullyQualifiedDomainNamein theHostheader 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
Hostheader:-
If you specify a value of
80forPortandHTTPorHTTP_STR_MATCHforType, Route 53 passes the value ofFullyQualifiedDomainNameto the endpoint in theHostheader. -
If you specify a value of
443forPortandHTTPSorHTTPS_STR_MATCHforType, Route 53 passes the value ofFullyQualifiedDomainNameto the endpoint in theHostheader. -
If you specify another value for
Portand any value exceptTCPforType, Route 53 passesFullyQualifiedDomainName:Portto the endpoint in theHostheader.
If you don't specify a value for
FullyQualifiedDomainName, Route 53 substitutes the value ofIPAddressin theHostheader 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 inFullyQualifiedDomainNameat the interval you specify inRequestInterval. 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 theFullyQualifiedDomainName; if you don’t specify a value forIPAddresson creation, aFullyQualifiedDomainNameis 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 forFullyQualifiedDomainName, 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 ofFullyQualifiedDomainName, specify the domain name of the server (such asus-east-2-www.example.com), not the name of the resource record sets (www.example.com).In this configuration, if the value of
FullyQualifiedDomainNamematches 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
TypeisHTTP,HTTPS,HTTP_STR_MATCH, orHTTPS_STR_MATCH, Route 53 passes the value ofFullyQualifiedDomainNamein theHostheader, as it does when you specify a value forIPAddress. If the value ofTypeisTCP, Route 53 doesn't pass aHostheader.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
searchString
If the value of
TypeisHTTP_STR_MATCHorHTTPS_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 ofTypewhen you update a health check.)- Parameters:
searchString- If the value ofTypeisHTTP_STR_MATCHorHTTPS_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 ofTypewhen you update a health check.)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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. Additionally, in disabled state, you can also invert the status of the health check to route traffic differently. For more information, see Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
- Parameters:
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. Additionally, in disabled state, you can also invert the status of the health check to route traffic differently. For more information, see Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
healthThreshold
The number of child health checks that are associated with a
CALCULATEDhealth that Amazon Route 53 must consider healthy for theCALCULATEDhealth check to be considered healthy. To specify the child health checks that you want to associate with aCALCULATEDhealth check, use theChildHealthChecksandChildHealthCheckelements.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.
- Parameters:
healthThreshold- The number of child health checks that are associated with aCALCULATEDhealth that Amazon Route 53 must consider healthy for theCALCULATEDhealth check to be considered healthy. To specify the child health checks that you want to associate with aCALCULATEDhealth check, use theChildHealthChecksandChildHealthCheckelements.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:
- Returns a reference to this object so that method calls can be chained together.
-
-
childHealthChecks
A complex type that contains one
ChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.- Parameters:
childHealthChecks- A complex type that contains oneChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childHealthChecks
A complex type that contains one
ChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.- Parameters:
childHealthChecks- A complex type that contains oneChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableSNI
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainNameto the endpoint in theclient_hellomessage duringTLSnegotiation. This allows the endpoint to respond toHTTPShealth check requests with the applicable SSL/TLS certificate.Some endpoints require that HTTPS requests include the host name in the
client_hellomessage. If you don't enable SNI, the status of the health check will be SSL alerthandshake_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 Namefield and possibly several more in theSubject Alternative Namesfield. One of the domain names in the certificate should match the value that you specify forFullyQualifiedDomainName. If the endpoint responds to theclient_hellomessage with a certificate that does not include the domain name that you specified inFullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omitFullyQualifiedDomainNamefrom theclient_hellomessage.- Parameters:
enableSNI- Specify whether you want Amazon Route 53 to send the value ofFullyQualifiedDomainNameto the endpoint in theclient_hellomessage duringTLSnegotiation. This allows the endpoint to respond toHTTPShealth check requests with the applicable SSL/TLS certificate.Some endpoints require that HTTPS requests include the host name in the
client_hellomessage. If you don't enable SNI, the status of the health check will be SSL alerthandshake_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 Namefield and possibly several more in theSubject Alternative Namesfield. One of the domain names in the certificate should match the value that you specify forFullyQualifiedDomainName. If the endpoint responds to theclient_hellomessage with a certificate that does not include the domain name that you specified inFullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omitFullyQualifiedDomainNamefrom theclient_hellomessage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regionsWithStrings
A complex type that contains one
Regionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Parameters:
regions- A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regionsWithStrings
A complex type that contains one
Regionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Parameters:
regions- A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regions
A complex type that contains one
Regionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Parameters:
regions- A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regions
A complex type that contains one
Regionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Parameters:
regions- A complex type that contains oneRegionelement for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
alarmIdentifier
default UpdateHealthCheckRequest.Builder alarmIdentifier(Consumer<AlarmIdentifier.Builder> 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.
This is a convenience method that creates an instance of theAlarmIdentifier.Builderavoiding the need to create one manually viaAlarmIdentifier.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toalarmIdentifier(AlarmIdentifier).- Parameters:
alarmIdentifier- a consumer that will call methods onAlarmIdentifier.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
insufficientDataHealthStatus
UpdateHealthCheckRequest.Builder insufficientDataHealthStatus(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
resetElementsWithStrings
A complex type that contains one
ResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
- Parameters:
resetElements- A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resetElementsWithStrings
A complex type that contains one
ResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
- Parameters:
resetElements- A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resetElements
A complex type that contains one
ResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
- Parameters:
resetElements- A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resetElements
A complex type that contains one
ResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
- Parameters:
resetElements- A complex type that contains oneResettableElementNameelement for each element that you want to reset to the default value. Valid values forResettableElementNameinclude the following:-
ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null. -
FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null. -
Regions: Route 53 resets the Regions list to the default set of regions. -
ResourcePath: Route 53 resets ResourcePath to null.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
UpdateHealthCheckRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateHealthCheckRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-