amazonka-route53-1.4.5: Amazon Route 53 SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53.CreateHealthCheck

Contents

Description

Creates a new health check.

To create a new health check, send a POST request to the 2013-04-01healthcheck resource. The request body must include a document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element, containing the health check ID specified when adding health check to a resource record set. For information about adding health checks to resource record sets, see 'ResourceRecordSet$HealthCheckId' in ChangeResourceRecordSets .

If you are 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.

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 .

Synopsis

Creating a Request

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 failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a 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 # 
Data 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 # 
Show CreateHealthCheck # 
Generic CreateHealthCheck # 
Hashable CreateHealthCheck # 
NFData CreateHealthCheck # 

Methods

rnf :: CreateHealthCheck -> () #

AWSRequest CreateHealthCheck # 
ToElement CreateHealthCheck # 
ToXML CreateHealthCheck # 
ToQuery CreateHealthCheck # 
ToPath CreateHealthCheck # 
ToHeaders CreateHealthCheck # 
type Rep CreateHealthCheck # 
type Rep CreateHealthCheck = D1 (MetaData "CreateHealthCheck" "Network.AWS.Route53.CreateHealthCheck" "amazonka-route53-1.4.5-1GBIEWLx4PAkG5NoOOGoJ" False) (C1 (MetaCons "CreateHealthCheck'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_chcCallerReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_chcHealthCheckConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HealthCheckConfig))))
type Rs CreateHealthCheck # 

Request Lenses

chcCallerReference :: Lens' CreateHealthCheck Text #

A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check.

chcHealthCheckConfig :: Lens' CreateHealthCheck HealthCheckConfig #

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

Destructuring the Response

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:

data CreateHealthCheckResponse #

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

See: createHealthCheckResponse smart constructor.

Instances

Eq CreateHealthCheckResponse # 
Data CreateHealthCheckResponse # 

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 # 
Show CreateHealthCheckResponse # 
Generic CreateHealthCheckResponse # 
NFData CreateHealthCheckResponse # 
type Rep CreateHealthCheckResponse # 
type Rep CreateHealthCheckResponse = D1 (MetaData "CreateHealthCheckResponse" "Network.AWS.Route53.CreateHealthCheck" "amazonka-route53-1.4.5-1GBIEWLx4PAkG5NoOOGoJ" False) (C1 (MetaCons "CreateHealthCheckResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_chcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_chcrsHealthCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HealthCheck)) (S1 (MetaSel (Just Symbol "_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.