Network.AWS.Route53.UpdateHealthCheck

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.

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 information about the request to update a

health check.

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)

ToElement UpdateHealthCheck

Methods

toElement :: UpdateHealthCheck -> Element

ToXML UpdateHealthCheck

Methods

toXML :: UpdateHealthCheck -> XML

ToQuery UpdateHealthCheck

Methods

toQuery :: UpdateHealthCheck -> QueryString

ToPath UpdateHealthCheck

Methods

toPath :: UpdateHealthCheck -> ByteString

ToHeaders UpdateHealthCheck

Methods

toHeaders :: UpdateHealthCheck -> [Header]

type Rep UpdateHealthCheck

type Rep UpdateHealthCheck = D1 (MetaData "UpdateHealthCheck" "Network.AWS.Route53.UpdateHealthCheck" "amazonka-route53-1.4.1-7tbQwgQHkMc6ifX3UPZcPu" 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.

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)

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)

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)

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)

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))

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)

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)

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)

Undocumented member.

uhcInverted :: Lens' UpdateHealthCheck (Maybe Bool)

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)

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]

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)

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

The ID of the health check to update.

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.1-7tbQwgQHkMc6ifX3UPZcPu" False) (C1 (MetaCons "UpdateHealthCheckResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uhcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.