amazonka-route53-2.0: Amazon Route 53 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53.CreateHealthCheck

Description

Creates a new health check.

For information about adding health checks to resource record sets, see 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 a 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:

  • 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

data CreateHealthCheck Source #

A complex type that contains the health check request information.

See: newCreateHealthCheck smart constructor.

Constructors

CreateHealthCheck' 

Fields

  • callerReference :: 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, 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, 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, Route 53 returns a HealthCheckAlreadyExists error.
    • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.
  • healthCheckConfig :: HealthCheckConfig

    A complex type that contains settings for a new health check.

Instances

Instances details
ToHeaders CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

ToPath CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

ToQuery CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

ToElement CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

ToXML CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

AWSRequest CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Associated Types

type AWSResponse CreateHealthCheck #

Generic CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Associated Types

type Rep CreateHealthCheck :: Type -> Type #

Read CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Show CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

NFData CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Methods

rnf :: CreateHealthCheck -> () #

Eq CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Hashable CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

type AWSResponse CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

type Rep CreateHealthCheck Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

type Rep CreateHealthCheck = D1 ('MetaData "CreateHealthCheck" "Amazonka.Route53.CreateHealthCheck" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "CreateHealthCheck'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callerReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "healthCheckConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HealthCheckConfig)))

newCreateHealthCheck Source #

Create a value of CreateHealthCheck with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateHealthCheck, createHealthCheck_callerReference - 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, 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, 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, Route 53 returns a HealthCheckAlreadyExists error.
  • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

CreateHealthCheck, createHealthCheck_healthCheckConfig - A complex type that contains settings for a new health check.

Request Lenses

createHealthCheck_callerReference :: Lens' CreateHealthCheck Text Source #

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, 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, 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, Route 53 returns a HealthCheckAlreadyExists error.
  • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

createHealthCheck_healthCheckConfig :: Lens' CreateHealthCheck HealthCheckConfig Source #

A complex type that contains settings for a new health check.

Destructuring the Response

data CreateHealthCheckResponse Source #

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

See: newCreateHealthCheckResponse smart constructor.

Constructors

CreateHealthCheckResponse' 

Fields

Instances

Instances details
Generic CreateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Associated Types

type Rep CreateHealthCheckResponse :: Type -> Type #

Read CreateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Show CreateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

NFData CreateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

Eq CreateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

type Rep CreateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Route53.CreateHealthCheck

type Rep CreateHealthCheckResponse = D1 ('MetaData "CreateHealthCheckResponse" "Amazonka.Route53.CreateHealthCheck" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "CreateHealthCheckResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "healthCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HealthCheck) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateHealthCheckResponse Source #

Create a value of CreateHealthCheckResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateHealthCheckResponse', createHealthCheckResponse_httpStatus - The response's http status code.

$sel:healthCheck:CreateHealthCheckResponse', createHealthCheckResponse_healthCheck - A complex type that contains identifying information about the health check.

$sel:location:CreateHealthCheckResponse', createHealthCheckResponse_location - The unique URL representing the new health check.

Response Lenses

createHealthCheckResponse_healthCheck :: Lens' CreateHealthCheckResponse HealthCheck Source #

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

createHealthCheckResponse_location :: Lens' CreateHealthCheckResponse Text Source #

The unique URL representing the new health check.