Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.Route53.CreateHealthCheck

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new health check.

For information about adding health checks to resource record sets, see 'ResourceRecordSet$HealthCheckId' in ChangeResourceRecordSets .

ELB Load Balancers

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.

Private Hosted Zones

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide .

Creating a Request

createHealthCheck #

Arguments

:: Text	`chcCallerReference`
-> HealthCheckConfig	`chcHealthCheckConfig`
-> CreateHealthCheck

Creates a value of CreateHealthCheck with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

chcCallerReference - A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks: * If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check. * If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Amazon Route 53 returns a HealthCheckAlreadyExists error. * If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Amazon Route 53 returns a HealthCheckAlreadyExists error. * If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Amazon Route 53 creates the health check.
chcHealthCheckConfig - A complex type that contains the response to a CreateHealthCheck request.

data CreateHealthCheck #

A complex type that contains the health check request information.

See: createHealthCheck smart constructor.

Instances

Eq CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods (==) :: CreateHealthCheck -> CreateHealthCheck -> Bool # (/=) :: CreateHealthCheck -> CreateHealthCheck -> Bool #
Data CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateHealthCheck -> c CreateHealthCheck # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateHealthCheck # toConstr :: CreateHealthCheck -> Constr # dataTypeOf :: CreateHealthCheck -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateHealthCheck) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateHealthCheck) # gmapT :: (forall b. Data b => b -> b) -> CreateHealthCheck -> CreateHealthCheck # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateHealthCheck -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateHealthCheck -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateHealthCheck -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateHealthCheck -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateHealthCheck -> m CreateHealthCheck # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHealthCheck -> m CreateHealthCheck # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHealthCheck -> m CreateHealthCheck #
Read CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods readsPrec :: Int -> ReadS CreateHealthCheck # readList :: ReadS [CreateHealthCheck] # readPrec :: ReadPrec CreateHealthCheck # readListPrec :: ReadPrec [CreateHealthCheck] #
Show CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods showsPrec :: Int -> CreateHealthCheck -> ShowS # show :: CreateHealthCheck -> String # showList :: [CreateHealthCheck] -> ShowS #
Generic CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Associated Types type Rep CreateHealthCheck :: * -> * # Methods from :: CreateHealthCheck -> Rep CreateHealthCheck x # to :: Rep CreateHealthCheck x -> CreateHealthCheck #
Hashable CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods hashWithSalt :: Int -> CreateHealthCheck -> Int # hash :: CreateHealthCheck -> Int #
AWSRequest CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Associated Types type Rs CreateHealthCheck :: * # Methods request :: CreateHealthCheck -> Request CreateHealthCheck # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateHealthCheck -> ClientResponse -> m (Response CreateHealthCheck) #
ToElement CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods toElement :: CreateHealthCheck -> Element #
ToXML CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods toXML :: CreateHealthCheck -> XML #
ToHeaders CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods toHeaders :: CreateHealthCheck -> [Header] #
ToPath CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods toPath :: CreateHealthCheck -> ByteString #
ToQuery CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods toQuery :: CreateHealthCheck -> QueryString #
NFData CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods rnf :: CreateHealthCheck -> () #
type Rep CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck type Rep CreateHealthCheck = D1 (MetaData "CreateHealthCheck" "Network.AWS.Route53.CreateHealthCheck" "amazonka-route53-1.6.0-P8x47gYAPqA73vX07XKxO" False) (C1 (MetaCons "CreateHealthCheck'" PrefixI True) (S1 (MetaSel (Just "_chcCallerReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_chcHealthCheckConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HealthCheckConfig)))
type Rs CreateHealthCheck #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck type Rs CreateHealthCheck = CreateHealthCheckResponse

Request Lenses

chcCallerReference :: Lens' CreateHealthCheck Text #

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks: * If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check. * If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Amazon Route 53 returns a HealthCheckAlreadyExists error. * If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Amazon Route 53 returns a HealthCheckAlreadyExists error. * If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Amazon Route 53 creates the health check.

chcHealthCheckConfig :: Lens' CreateHealthCheck HealthCheckConfig #

A complex type that contains the response to a CreateHealthCheck request.

Destructuring the Response

createHealthCheckResponse #

Arguments

:: Int	`chcrsResponseStatus`
-> HealthCheck	`chcrsHealthCheck`
-> Text	`chcrsLocation`
-> CreateHealthCheckResponse

Creates a value of CreateHealthCheckResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

chcrsResponseStatus - -- | The response status code.
chcrsHealthCheck - A complex type that contains identifying information about the health check.
chcrsLocation - The unique URL representing the new health check.

data CreateHealthCheckResponse #

A complex type containing the response information for the new health check.

See: createHealthCheckResponse smart constructor.

Instances

Eq CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods (==) :: CreateHealthCheckResponse -> CreateHealthCheckResponse -> Bool # (/=) :: CreateHealthCheckResponse -> CreateHealthCheckResponse -> Bool #
Data CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateHealthCheckResponse -> c CreateHealthCheckResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateHealthCheckResponse # toConstr :: CreateHealthCheckResponse -> Constr # dataTypeOf :: CreateHealthCheckResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateHealthCheckResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateHealthCheckResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateHealthCheckResponse -> CreateHealthCheckResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateHealthCheckResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateHealthCheckResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateHealthCheckResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateHealthCheckResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateHealthCheckResponse -> m CreateHealthCheckResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHealthCheckResponse -> m CreateHealthCheckResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHealthCheckResponse -> m CreateHealthCheckResponse #
Read CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods readsPrec :: Int -> ReadS CreateHealthCheckResponse # readList :: ReadS [CreateHealthCheckResponse] # readPrec :: ReadPrec CreateHealthCheckResponse # readListPrec :: ReadPrec [CreateHealthCheckResponse] #
Show CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods showsPrec :: Int -> CreateHealthCheckResponse -> ShowS # show :: CreateHealthCheckResponse -> String # showList :: [CreateHealthCheckResponse] -> ShowS #
Generic CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Associated Types type Rep CreateHealthCheckResponse :: * -> * # Methods from :: CreateHealthCheckResponse -> Rep CreateHealthCheckResponse x # to :: Rep CreateHealthCheckResponse x -> CreateHealthCheckResponse #
NFData CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck Methods rnf :: CreateHealthCheckResponse -> () #
type Rep CreateHealthCheckResponse #
Instance details Defined in Network.AWS.Route53.CreateHealthCheck type Rep CreateHealthCheckResponse = D1 (MetaData "CreateHealthCheckResponse" "Network.AWS.Route53.CreateHealthCheck" "amazonka-route53-1.6.0-P8x47gYAPqA73vX07XKxO" False) (C1 (MetaCons "CreateHealthCheckResponse'" PrefixI True) (S1 (MetaSel (Just "_chcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: (S1 (MetaSel (Just "_chcrsHealthCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HealthCheck) :: S1 (MetaSel (Just "_chcrsLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

Response Lenses

chcrsResponseStatus :: Lens' CreateHealthCheckResponse Int #

- | The response status code.

chcrsHealthCheck :: Lens' CreateHealthCheckResponse HealthCheck #

A complex type that contains identifying information about the health check.

chcrsLocation :: Lens' CreateHealthCheckResponse Text #

The unique URL representing the new health check.