Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new health check.
To create a new health check, send a POST
request to the '\/2013-04-01\/healthcheck' resource. The request body must include an XML 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 ResourceRecordSetHealthCheckId> in ChangeResourceRecordSets.
If you are registering Amazon EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the Amazon EC2 instances. When you register an Amazon 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 Developer Guide.
- createHealthCheck :: Text -> HealthCheckConfig -> CreateHealthCheck
- data CreateHealthCheck
- chcCallerReference :: Lens' CreateHealthCheck Text
- chcHealthCheckConfig :: Lens' CreateHealthCheck HealthCheckConfig
- createHealthCheckResponse :: Int -> HealthCheck -> Text -> CreateHealthCheckResponse
- data CreateHealthCheckResponse
- chcrsResponseStatus :: Lens' CreateHealthCheckResponse Int
- chcrsHealthCheck :: Lens' CreateHealthCheckResponse HealthCheck
- chcrsLocation :: Lens' CreateHealthCheckResponse Text
Creating a Request
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:
data CreateHealthCheck Source #
A complex type that contains the health check request information.
See: createHealthCheck
smart constructor.
Request Lenses
chcCallerReference :: Lens' CreateHealthCheck Text Source #
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 Source #
A complex type that contains the response to a CreateHealthCheck
request.
Destructuring the Response
createHealthCheckResponse Source #
:: Int | |
-> HealthCheck | |
-> Text | |
-> 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 Source #
A complex type containing the response information for the new health check.
See: createHealthCheckResponse
smart constructor.
Response Lenses
chcrsResponseStatus :: Lens' CreateHealthCheckResponse Int Source #
The response status code.
chcrsHealthCheck :: Lens' CreateHealthCheckResponse HealthCheck Source #
A complex type that contains identifying information about the health check.
chcrsLocation :: Lens' CreateHealthCheckResponse Text Source #
The unique URL representing the new health check.