Network.AWS.Route53.UpdateHealthCheck

Updates an existing health check.

Send a POST request to the '/Amazon Route 53 API version/healthcheck/health check ID ' resource. The request body must include an XML document with an UpdateHealthCheckRequest element. For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

Creating a Request

updateHealthCheck

Arguments

:: Text

uhcHealthCheckId

-> UpdateHealthCheck

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:

• uhcFailureThreshold
• uhcIPAddress
• uhcEnableSNI
• uhcSearchString
• uhcHealthThreshold
• uhcRegions
• uhcResourcePath
• uhcInsufficientDataHealthStatus
• uhcHealthCheckVersion
• uhcAlarmIdentifier
• uhcInverted
• uhcFullyQualifiedDomainName
• uhcChildHealthChecks
• uhcPort
• uhcHealthCheckId

data UpdateHealthCheck

A complex type that contains the health check request information.

See: updateHealthCheck smart constructor.

Instances

Eq UpdateHealthCheck

Methods

(==) :: UpdateHealthCheck -> UpdateHealthCheck -> Bool

(/=) :: UpdateHealthCheck -> UpdateHealthCheck -> Bool

Data UpdateHealthCheck

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateHealthCheck -> c UpdateHealthCheck

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateHealthCheck

toConstr :: UpdateHealthCheck -> Constr

dataTypeOf :: UpdateHealthCheck -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateHealthCheck)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateHealthCheck)

gmapT :: (forall b. Data b => b -> b) -> UpdateHealthCheck -> UpdateHealthCheck

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateHealthCheck -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateHealthCheck -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateHealthCheck -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateHealthCheck -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateHealthCheck -> m UpdateHealthCheck

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateHealthCheck -> m UpdateHealthCheck

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateHealthCheck -> m UpdateHealthCheck

Read UpdateHealthCheck

Methods

readsPrec :: Int -> ReadS UpdateHealthCheck

readList :: ReadS [UpdateHealthCheck]

readPrec :: ReadPrec UpdateHealthCheck

readListPrec :: ReadPrec [UpdateHealthCheck]

Show UpdateHealthCheck

Methods

showsPrec :: Int -> UpdateHealthCheck -> ShowS

show :: UpdateHealthCheck -> String

showList :: [UpdateHealthCheck] -> ShowS

Generic UpdateHealthCheck

Associated Types

type Rep UpdateHealthCheck :: * -> *

Methods

from :: UpdateHealthCheck -> Rep UpdateHealthCheck x

to :: Rep UpdateHealthCheck x -> UpdateHealthCheck

Hashable UpdateHealthCheck

Methods

hashWithSalt :: Int -> UpdateHealthCheck -> Int

hash :: UpdateHealthCheck -> Int

NFData UpdateHealthCheck

Methods

rnf :: UpdateHealthCheck -> ()

AWSRequest UpdateHealthCheck

Associated Types

type Rs UpdateHealthCheck :: *

Methods

request :: UpdateHealthCheck -> Request UpdateHealthCheck

response :: MonadResource m => Logger -> Service -> Proxy * UpdateHealthCheck -> ClientResponse -> m (Response UpdateHealthCheck)

ToPath UpdateHealthCheck

Methods

toPath :: UpdateHealthCheck -> ByteString

ToHeaders UpdateHealthCheck

Methods

toHeaders :: UpdateHealthCheck -> [Header]

ToElement UpdateHealthCheck

Methods

toElement :: UpdateHealthCheck -> Element

ToXML UpdateHealthCheck

Methods

toXML :: UpdateHealthCheck -> XML

ToQuery UpdateHealthCheck

Methods

toQuery :: UpdateHealthCheck -> QueryString

type Rep UpdateHealthCheck

type Rep UpdateHealthCheck = D1 (MetaData "UpdateHealthCheck" "Network.AWS.Route53.UpdateHealthCheck" "amazonka-route53-1.4.4-KBIXDpJOcpkWbDD9G5tXJ" False) (C1 (MetaCons "UpdateHealthCheck'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uhcFailureThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_uhcIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uhcEnableSNI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uhcSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uhcHealthThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_uhcRegions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 HealthCheckRegion)))) (S1 (MetaSel (Just Symbol "_uhcResourcePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uhcInsufficientDataHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InsufficientDataHealthStatus))) (S1 (MetaSel (Just Symbol "_uhcHealthCheckVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_uhcAlarmIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AlarmIdentifier))) (S1 (MetaSel (Just Symbol "_uhcInverted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uhcFullyQualifiedDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uhcChildHealthChecks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_uhcPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_uhcHealthCheckId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs UpdateHealthCheck

type Rs UpdateHealthCheck = UpdateHealthCheckResponse

Request Lenses

uhcFailureThreshold :: Lens' UpdateHealthCheck (Maybe Natural)

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.

uhcIPAddress :: Lens' UpdateHealthCheck (Maybe Text)

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

f the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon 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 Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux 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 of IPAddress.

For more information, see UpdateHealthCheckRequestFullyQualifiedDomainName>.

uhcEnableSNI :: Lens' UpdateHealthCheck (Maybe Bool)

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

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

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

uhcSearchString :: Lens' UpdateHealthCheck (Maybe Text)

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

uhcHealthThreshold :: Lens' UpdateHealthCheck (Maybe Natural)

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, Amazon Route 53 always considers this health check to be unhealthy.
• If you specify '0', Amazon Route 53 always considers this health check to be healthy.

uhcRegions :: Lens' UpdateHealthCheck (Maybe (NonEmpty HealthCheckRegion))

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

uhcResourcePath :: Lens' UpdateHealthCheck (Maybe Text)

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)

Undocumented member.

uhcHealthCheckVersion :: Lens' UpdateHealthCheck (Maybe Natural)

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 Amazon Route 53 from overwriting an intervening update:

• f the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Amazon 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. Amazon Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

uhcAlarmIdentifier :: Lens' UpdateHealthCheck (Maybe AlarmIdentifier)

Undocumented member.

uhcInverted :: Lens' UpdateHealthCheck (Maybe Bool)

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

uhcFullyQualifiedDomainName :: Lens' UpdateHealthCheck (Maybe Text)

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

The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks. When Amazon 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, Amazon 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, Amazon 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, Amazon Route 53 passes 'FullyQualifiedDomainName':'Port' to the endpoint in the Host header.

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

If you don't specify IPAddress:

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

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-1-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, Amazon 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, Amazon Route 53 doesn't pass a Host header.

uhcChildHealthChecks :: Lens' UpdateHealthCheck [Text]

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

uhcPort :: Lens' UpdateHealthCheck (Maybe Natural)

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

uhcHealthCheckId :: Lens' UpdateHealthCheck Text

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.

Destructuring the Response

updateHealthCheckResponse

Arguments

:: Int

uhcrsResponseStatus

-> HealthCheck

uhcrsHealthCheck

-> UpdateHealthCheckResponse

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:

• uhcrsResponseStatus
• uhcrsHealthCheck

data UpdateHealthCheckResponse

See: updateHealthCheckResponse smart constructor.

Instances

Eq UpdateHealthCheckResponse

Methods

(==) :: UpdateHealthCheckResponse -> UpdateHealthCheckResponse -> Bool

(/=) :: UpdateHealthCheckResponse -> UpdateHealthCheckResponse -> Bool

Data UpdateHealthCheckResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateHealthCheckResponse -> c UpdateHealthCheckResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateHealthCheckResponse

toConstr :: UpdateHealthCheckResponse -> Constr

dataTypeOf :: UpdateHealthCheckResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateHealthCheckResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateHealthCheckResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateHealthCheckResponse -> UpdateHealthCheckResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateHealthCheckResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateHealthCheckResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateHealthCheckResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateHealthCheckResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateHealthCheckResponse -> m UpdateHealthCheckResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateHealthCheckResponse -> m UpdateHealthCheckResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateHealthCheckResponse -> m UpdateHealthCheckResponse

Read UpdateHealthCheckResponse

Methods

readsPrec :: Int -> ReadS UpdateHealthCheckResponse

readList :: ReadS [UpdateHealthCheckResponse]

readPrec :: ReadPrec UpdateHealthCheckResponse

readListPrec :: ReadPrec [UpdateHealthCheckResponse]

Show UpdateHealthCheckResponse

Methods

showsPrec :: Int -> UpdateHealthCheckResponse -> ShowS

show :: UpdateHealthCheckResponse -> String

showList :: [UpdateHealthCheckResponse] -> ShowS

Generic UpdateHealthCheckResponse

Associated Types

type Rep UpdateHealthCheckResponse :: * -> *

Methods

from :: UpdateHealthCheckResponse -> Rep UpdateHealthCheckResponse x

to :: Rep UpdateHealthCheckResponse x -> UpdateHealthCheckResponse

NFData UpdateHealthCheckResponse

Methods

rnf :: UpdateHealthCheckResponse -> ()

type Rep UpdateHealthCheckResponse

type Rep UpdateHealthCheckResponse = D1 (MetaData "UpdateHealthCheckResponse" "Network.AWS.Route53.UpdateHealthCheck" "amazonka-route53-1.4.4-KBIXDpJOcpkWbDD9G5tXJ" False) (C1 (MetaCons "UpdateHealthCheckResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uhcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_uhcrsHealthCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HealthCheck))))

Response Lenses

uhcrsResponseStatus :: Lens' UpdateHealthCheckResponse Int

The response status code.

uhcrsHealthCheck :: Lens' UpdateHealthCheckResponse HealthCheck

Undocumented member.