AWS CDK Route53 HealthCheck
Create Route53 HealthChecks to monitor TCP, HTTP, HTTPS endpoints, to monitor CloudWatch Alarms and to monitor other Route53 HealthChecks.
Currently supported types of Route53 HealthChecks:
- Health checks that monitor an endpoint
- Health checks that monitor other health checks
- Health checks that monitor CloudWatch alarms
- Configure DNS failover
Easily create a CloudWatch Alarm based on the Route53 HealthCheck:
const healthCheck = new EndpointHealthCheck(scope, "HealthCheck", {
domainName: "pepperize.com",
});
const alarm = new cloudwatch.Alarm(scope, "Alarm", {
metric: healthCheck.metricHealthCheckStatus(),
comparisonOperator: cloudwatch.ComparisonOperator.LESS_THAN_THRESHOLD,
threshold: 1,
evaluationPeriods: 1,
});
See more options API Reference
Install
TypeScript
npm install @pepperize/cdk-route53-health-check
or
yarn add @pepperize/cdk-route53-health-check
Python
pip install pepperize.cdk-route53-health-check
C# / .Net
dotnet add package Pepperize.CDK.Route53HealthCheck
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-route53-health-check</artifactId>
<version>${cdkRoute53HealthCheck.version}</version>
</dependency>
Usage
npm install @pepperize/cdk-route53-health-check
See API.md.
HealthCheck for an endpoint
HTTPS health check
new EndpointHealthCheck(scope, "HealthCheck", {
domainName: "pepperize.com",
});
Generates
Resources:
Type: AWS::Route53::HealthCheck
Properties:
HealthCheckConfig:
FullyQualifiedDomainName: "pepperize.com"
Port: 443
Type: "HTTPS"
EnableSNI: true
Additional configuration options
new EndpointHealthCheck(scope, "HealthCheck", {
domainName: "pepperize.com", // The domain name that Route53 performs health checks on. Route53 resolves the IP address and performs the lookup.
enableSni: true, // Specify that Route53 sends the host name for TLS negotiation.
failureThreshold: 3, // The number of consecutive health checks that an endpoint must pass or fail for Route53 to change the current status of the endpoint between healthy and unhealthy.
healthCheckName: "pepperize.com", // The display name of this Route53 HealthCheck.
inverted: false, // Whether to invert the status of the Route53 health check status.
ipAddress: "1.1.1.1", // The ip address that Route53 performs health checks on. Optionally a domain name may be given.
latencyGraphs: true, // Whether Route53 measures the latency between health checkers in multiple AWS regions and your endpoint, and displays a CloudWatch latency graphs in the Route53 console.
port: 443, // The port that Route53 performs health checks.
protocol: Protocol.HTTPS, // The protocol that Route53 uses to communicate with the endpoint.
regions: [HealthCheckerRegions.EU_WEST_1, HealthCheckerRegions.US_EAST_1, HealthCheckerRegions.US_WEST_1], // The list of regions from which Route53 health checkers check the endpoint.
requestInterval: 30, // The number of seconds between the time that Route53 gets a response from your endpoint and the time that it sends the next health check request.
resourcePath: "/health-check", // The path for HTTP or HTTPS health checks.
searchString: "OK", // The search string for HTTP or HTTPS health checks.
});
See for more options API Reference - EndpointHealthCheckProps
HealthCheck to monitor other HealthChecks
const healthCheck1 = new EndpointHealthCheck(stack, "HealthCheck1", {
domainName: "pepperize.com",
});
const healthCheck2 = EndpointHealthCheck.fromHealthCheckId(
scope,
"HealthCheck2",
"9ebee2db-6292-4803-9838-327e6example"
);
new CalculatedHealthCheck(scope, "CalculatedHealthCheck", {
childHealthChecks: [healthCheck1, healthCheck2],
});
See for more options API Reference - CalculatedHealthCheckProps
HealthCheck to monitor CloudWatch Alarms
const alarm = cloudwatch.Alarm.fromAlarmArn(
scope,
"Alarm",
"arn:aws:cloudwatch:us-east-1:123456789012:alarm:any-alarm"
);
new AlarmHealthCheck(scope, "HealthCheck", {
alarm: alarm,
});
See for more options API Reference - AlarmHealthCheckProps
Configuring DNS Failover
An example active-passive DNS failover configuration
Primary
// An alias record set for a CloudFront distribution
const recordSetPrimary = new route53.ARecord(scope, "RecordSetPrimary", {
recordName: "www.pepperize.com",
zone: hostedZone,
target: route53.RecordTarget.fromAlias(new targets.CloudFrontTarget(distribution)),
});
// The health check for the CloudFront distribution
const healthCheckPrimary = new EndpointHealthCheck(scope, "HealthCheckPrimary", {
domainName: "www.pepperize.com",
});
// Configure the HealthCheckId and Failover on the record set
healthCheckPrimary.failoverPrimary(recordSetPrimary);
Secondary
// An alias record set for an Application Load Balancer
const recordSetSecondary = new route53.ARecord(scope, "RecordSetSecondary", {
recordName: "www-1.pepperize.com",
zone: hostedZone,
target: route53.RecordTarget.fromAlias(new targets.LoadBalancerTarget(alb)),
});
// The health check for the Application Load Balancer
const healthCheckSecondary = new EndpointHealthCheck(scope, "HealthCheckSecondary", {
domainName: "www-1.pepperize.com",
});
// Configure the HealthCheckId and Failover on the record set
healthCheckSecondary.failoverSecondary(recordSetSecondary, true);
See for more options API Reference - IHealthCheck
How health checks work in complex Amazon Route 53 configurations
1 maintainer
Metadata
1 maintainer
Release files for pepperize.cdk-route53-health-check 0.0.755
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pepperize_cdk_route53_health_check-0.0.755.tar.gz | 249.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pepperize_cdk_route53_health_check-0.0.755-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 499.9 kB
Release files / pepperize_cdk_route53_health_check-0.0.755.tar.gz
| Download URL | pepperize_cdk_route53_health_check-0.0.755.tar.gz |
|---|---|
| Size | 249.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f3053883099f15eb04ef286458b25317ece78858f0cd25f64358fa91bb002ddc
|
|
BLAKE2b-256 checksum How to use checksums |
b7dda563d2a2a7873de51322a3b16997d244fc3010226e4a11865ea1f14f1d11
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.14.2
|
Release files / pepperize_cdk_route53_health_check-0.0.755-py3-none-any.whl
| Download URL | pepperize_cdk_route53_health_check-0.0.755-py3-none-any.whl |
|---|---|
| Size | 250.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f8793329849f16d1176c1a0201a16a24e77aceec44612849cb28bbb2c332c24
|
|
BLAKE2b-256 checksum How to use checksums |
a80e999ba6cfd9703d1cef057f93e9c3f85b96e3fa7f7634877038a2ad6cd585
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.14.2
|
