Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
This action updates an existing health check.
To update a health check, send a POST
request to the '/Route 53 API version/healthcheck/health check ID' resource. The request body must include a document with an UpdateHealthCheckRequest
element. The response returns an UpdateHealthCheckResponse
element, which contains metadata about the health check.
- updateHealthCheck :: Text -> UpdateHealthCheck
- data UpdateHealthCheck
- uhcFailureThreshold :: Lens' UpdateHealthCheck (Maybe Natural)
- uhcIPAddress :: Lens' UpdateHealthCheck (Maybe Text)
- uhcEnableSNI :: Lens' UpdateHealthCheck (Maybe Bool)
- uhcSearchString :: Lens' UpdateHealthCheck (Maybe Text)
- uhcHealthThreshold :: Lens' UpdateHealthCheck (Maybe Natural)
- uhcRegions :: Lens' UpdateHealthCheck (Maybe (NonEmpty HealthCheckRegion))
- uhcResourcePath :: Lens' UpdateHealthCheck (Maybe Text)
- uhcInsufficientDataHealthStatus :: Lens' UpdateHealthCheck (Maybe InsufficientDataHealthStatus)
- uhcHealthCheckVersion :: Lens' UpdateHealthCheck (Maybe Natural)
- uhcAlarmIdentifier :: Lens' UpdateHealthCheck (Maybe AlarmIdentifier)
- uhcInverted :: Lens' UpdateHealthCheck (Maybe Bool)
- uhcFullyQualifiedDomainName :: Lens' UpdateHealthCheck (Maybe Text)
- uhcChildHealthChecks :: Lens' UpdateHealthCheck [Text]
- uhcPort :: Lens' UpdateHealthCheck (Maybe Natural)
- uhcHealthCheckId :: Lens' UpdateHealthCheck Text
- updateHealthCheckResponse :: Int -> HealthCheck -> UpdateHealthCheckResponse
- data UpdateHealthCheckResponse
- uhcrsResponseStatus :: Lens' UpdateHealthCheckResponse Int
- uhcrsHealthCheck :: Lens' UpdateHealthCheckResponse HealthCheck
Creating a Request
Creates a value of UpdateHealthCheck
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateHealthCheck Source #
A complex type that contains information about the request to update a health check.
See: updateHealthCheck
smart constructor.
Request Lenses
uhcFailureThreshold :: Lens' UpdateHealthCheck (Maybe Natural) Source #
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.
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.
uhcIPAddress :: Lens' UpdateHealthCheck (Maybe Text) Source #
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
uhcEnableSNI :: Lens' UpdateHealthCheck (Maybe Bool) Source #
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName
to the endpoint in the client_hello
message during TLS negotiation. If you don't specify a value for EnableSNI
, Amazon Route 53 defaults to true
when Type
is HTTPS
or HTTPS_STR_MATCH
and defaults to false
when Type
is any other value.
Specify this value only if you want to change it.
uhcSearchString :: Lens' UpdateHealthCheck (Maybe Text) Source #
If the value of Type
is HTTP_STR_MATCH
or HTTP_STR_MATCH
, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString
in the response body.
Specify this value only if you want to change it.
uhcHealthThreshold :: Lens' UpdateHealthCheck (Maybe Natural) Source #
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
uhcRegions :: Lens' UpdateHealthCheck (Maybe (NonEmpty HealthCheckRegion)) Source #
A list of HealthCheckRegion
values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions.
When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region.
Specify this value only if you want to change it.
uhcResourcePath :: Lens' UpdateHealthCheck (Maybe Text) Source #
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.
uhcInsufficientDataHealthStatus :: Lens' UpdateHealthCheck (Maybe InsufficientDataHealthStatus) Source #
Undocumented member.
uhcHealthCheckVersion :: Lens' UpdateHealthCheck (Maybe Natural) Source #
Optional. When you specify a health check version, Amazon 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.
uhcAlarmIdentifier :: Lens' UpdateHealthCheck (Maybe AlarmIdentifier) Source #
Undocumented member.
uhcInverted :: Lens' UpdateHealthCheck (Maybe Bool) Source #
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted
is True
, then Amazon Route 53 considers the health check to be unhealthy.
Specify this value only if you want to change it.
uhcFullyQualifiedDomainName :: Lens' UpdateHealthCheck (Maybe Text) Source #
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
uhcChildHealthChecks :: Lens' UpdateHealthCheck [Text] Source #
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Specify this value only if you want to change it.
uhcPort :: Lens' UpdateHealthCheck (Maybe Natural) Source #
The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
uhcHealthCheckId :: Lens' UpdateHealthCheck Text Source #
The ID of the health check to update.
Destructuring the Response
updateHealthCheckResponse Source #
Creates a value of UpdateHealthCheckResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateHealthCheckResponse Source #
See: updateHealthCheckResponse
smart constructor.
Response Lenses
uhcrsResponseStatus :: Lens' UpdateHealthCheckResponse Int Source #
The response status code.
uhcrsHealthCheck :: Lens' UpdateHealthCheckResponse HealthCheck Source #
Undocumented member.