public class UpdateHealthCheckRequest extends AmazonWebServiceRequest implements Serializable
UpdateHealthCheck operation
.
This action updates an existing health check.
To update a health check, send a POST
request to the
2013-05-27/healthcheck/health check ID
resource. The
request body must include an XML document with an
UpdateHealthCheckRequest
element. The response returns an
UpdateHealthCheckResponse
element, which contains
metadata about the health check.
NOOP
Constructor and Description |
---|
UpdateHealthCheckRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Integer |
getFailureThreshold()
The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa.
|
String |
getFullyQualifiedDomainName()
Fully qualified domain name of the instance to be health checked.
|
String |
getHealthCheckId()
The ID of the health check to update.
|
Long |
getHealthCheckVersion()
Optional.
|
String |
getIPAddress()
The IP address of the resource that you want to check.
|
Integer |
getPort()
The port on which you want Route 53 to open a connection to perform
health checks.
|
String |
getResourcePath()
The path that you want Amazon Route 53 to request when performing
health checks.
|
String |
getSearchString()
If the value of
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH , the string that you want Route 53 to
search for in the response body from the specified resource. |
int |
hashCode() |
void |
setFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa.
|
void |
setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
|
void |
setHealthCheckId(String healthCheckId)
The ID of the health check to update.
|
void |
setHealthCheckVersion(Long healthCheckVersion)
Optional.
|
void |
setIPAddress(String iPAddress)
The IP address of the resource that you want to check.
|
void |
setPort(Integer port)
The port on which you want Route 53 to open a connection to perform
health checks.
|
void |
setResourcePath(String resourcePath)
The path that you want Amazon Route 53 to request when performing
health checks.
|
void |
setSearchString(String searchString)
If the value of
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH , the string that you want Route 53 to
search for in the response body from the specified resource. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateHealthCheckRequest |
withFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa.
|
UpdateHealthCheckRequest |
withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
|
UpdateHealthCheckRequest |
withHealthCheckId(String healthCheckId)
The ID of the health check to update.
|
UpdateHealthCheckRequest |
withHealthCheckVersion(Long healthCheckVersion)
Optional.
|
UpdateHealthCheckRequest |
withIPAddress(String iPAddress)
The IP address of the resource that you want to check.
|
UpdateHealthCheckRequest |
withPort(Integer port)
The port on which you want Route 53 to open a connection to perform
health checks.
|
UpdateHealthCheckRequest |
withResourcePath(String resourcePath)
The path that you want Amazon Route 53 to request when performing
health checks.
|
UpdateHealthCheckRequest |
withSearchString(String searchString)
If the value of
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH , the string that you want Route 53 to
search for in the response body from the specified resource. |
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getHealthCheckId()
Constraints:
Length: 0 - 64
public void setHealthCheckId(String healthCheckId)
Constraints:
Length: 0 - 64
healthCheckId
- The ID of the health check to update.public UpdateHealthCheckRequest withHealthCheckId(String healthCheckId)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 64
healthCheckId
- The ID of the health check to update.public Long getHealthCheckVersion()
HealthCheckVersion
lets you prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
HealthCheckVersion
lets you prevent overwriting
another change to the health check.public void setHealthCheckVersion(Long healthCheckVersion)
HealthCheckVersion
lets you prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
healthCheckVersion
- Optional. When you specify a health check version, Route 53 compares
this value with the current value in the health check, which prevents
you from updating the health check when the versions don't match.
Using HealthCheckVersion
lets you prevent overwriting
another change to the health check.public UpdateHealthCheckRequest withHealthCheckVersion(Long healthCheckVersion)
HealthCheckVersion
lets you prevent overwriting
another change to the health check.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
healthCheckVersion
- Optional. When you specify a health check version, Route 53 compares
this value with the current value in the health check, which prevents
you from updating the health check when the versions don't match.
Using HealthCheckVersion
lets you prevent overwriting
another change to the health check.public String getIPAddress()
Specify this value only if you want to change it.
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Specify this value only if you want to change it.
public void setIPAddress(String iPAddress)
Specify this value only if you want to change it.
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
iPAddress
- The IP address of the resource that you want to check. Specify this value only if you want to change it.
public UpdateHealthCheckRequest withIPAddress(String iPAddress)
Specify this value only if you want to change it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
iPAddress
- The IP address of the resource that you want to check. Specify this value only if you want to change it.
public Integer getPort()
Specify this value only if you want to change it.
Constraints:
Range: 1 - 65535
Specify this value only if you want to change it.
public void setPort(Integer port)
Specify this value only if you want to change it.
Constraints:
Range: 1 - 65535
port
- The port on which you want Route 53 to open a connection to perform
health checks. Specify this value only if you want to change it.
public UpdateHealthCheckRequest withPort(Integer port)
Specify this value only if you want to change it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 65535
port
- The port on which you want Route 53 to open a connection to perform
health checks. Specify this value only if you want to change it.
public String getResourcePath()
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
Specify this value only if you want to change it.
public void setResourcePath(String resourcePath)
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
resourcePath
- The path that you want Amazon Route 53 to request when performing
health checks. The path can be any value for which your endpoint will
return an HTTP status code of 2xx or 3xx when the endpoint is healthy,
for example the file /docs/route53-health-check.html. Specify this value only if you want to change it.
public UpdateHealthCheckRequest withResourcePath(String resourcePath)
Specify this value only if you want to change it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
resourcePath
- The path that you want Amazon Route 53 to request when performing
health checks. The path can be any value for which your endpoint will
return an HTTP status code of 2xx or 3xx when the endpoint is healthy,
for example the file /docs/route53-health-check.html. Specify this value only if you want to change it.
public String getFullyQualifiedDomainName()
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
Specify this value only if you want to change it.
public void setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
fullyQualifiedDomainName
- Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Specify this value only if you want to change it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
fullyQualifiedDomainName
- Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
public String getSearchString()
Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want 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. Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want 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. Specify this value only if you want to change it.
public void setSearchString(String searchString)
Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want 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. Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
searchString
- If the value of Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want 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. Specify this value only if you want to change it.
public UpdateHealthCheckRequest withSearchString(String searchString)
Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want 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. Specify this value only if you want to change it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
searchString
- If the value of Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want 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. Specify this value only if you want to change it.
public Integer getFailureThreshold()
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Constraints:
Range: 1 - 10
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
public void setFailureThreshold(Integer failureThreshold)
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Constraints:
Range: 1 - 10
failureThreshold
- The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withFailureThreshold(Integer failureThreshold)
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 10
failureThreshold
- The number of consecutive health checks that an endpoint must pass or
fail for Route 53 to change the current status of the endpoint from
unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.