# API Reference
## Constructs
### AlarmHealthCheck
- *Implements:* IHealthCheck, aws-cdk-lib.ITaggable
Create a Route53 HealthCheck that monitors a CloudWatch Alarm.
Example
```typescript
const alarm new Alarm(stack, "Alarm", {
// ...
});
new AlarmHealthCheck(stack, "HealthCheck", {
alarm: alarm,
});
```
> [https://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#aws-resource-route53-healthcheck-properties](https://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#aws-resource-route53-healthcheck-properties)
#### Initializers
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
new AlarmHealthCheck(scope: Construct, id: string, props: AlarmHealthCheckProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AlarmHealthCheckProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* AlarmHealthCheckProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| applyRemovalPolicy | Apply the given removal policy to this resource. |
| failover | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| failoverPrimary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| failoverSecondary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| metric | Return the given named metric for this HealthCheck. |
| metricHealthCheckStatus | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops
being managed by CloudFormation, either because you've removed it from the
CDK application or because you've made a change that requires the resource
to be replaced.
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `failover`
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
###### `failover`Optional
- *Type:* Failover
---
##### `failoverPrimary`
```typescript
public failoverPrimary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
##### `failoverSecondary`
```typescript
public failoverSecondary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
##### `metric`
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`Required
- *Type:* string
---
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus`
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
| isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. |
| isResource | Check whether the given construct is a Resource. |
| fromHealthCheckId | Import an existing Route53 HealthCheck. |
---
##### ~~`isConstruct`~~
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `fromHealthCheckId`
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.fromHealthCheckId(scope: Construct, id: string, healthCheckId: string)
```
Import an existing Route53 HealthCheck.
###### `scope`Required
- *Type:* constructs.Construct
---
###### `id`Required
- *Type:* string
---
###### `healthCheckId`Required
- *Type:* string
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
| healthCheckId | string | *No description.* |
| tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
```
- *Type:* aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK
(generally, those created by creating new class instances like Role, Bucket, etc.),
this is always the same as the environment of the stack they belong to;
however, for imported resources
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
that might be different than the stack they were imported into.
---
##### `stack`Required
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `healthCheckId`Required
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
##### `tags`Required
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
### CalculatedHealthCheck
- *Implements:* IHealthCheck, aws-cdk-lib.ITaggable
Create a Route53 HealthCheck that monitors other Route53 HealthChecks.
Example
```typescript
const healthCheck = new EndpointHealthCheck(stack, "HealthCheck", {
domainName: "pepperize.com",
});
new CalculatedHealthCheck(stack, "CalculatedHealthCheck", {
childHealthChecks: [healthCheck],
});
```
> [https://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#aws-resource-route53-healthcheck-properties](https://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#aws-resource-route53-healthcheck-properties)
#### Initializers
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
new CalculatedHealthCheck(scope: Construct, id: string, props: CalculatedHealthCheckProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | CalculatedHealthCheckProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* CalculatedHealthCheckProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| applyRemovalPolicy | Apply the given removal policy to this resource. |
| addChildHealthCheck | *No description.* |
| failover | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| failoverPrimary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| failoverSecondary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| metric | Return the given named metric for this HealthCheck. |
| metricChildHealthCheckHealthyCount | The number of ChildHealthChecks that are healthy that Route53 is monitoring. |
| metricHealthCheckStatus | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops
being managed by CloudFormation, either because you've removed it from the
CDK application or because you've made a change that requires the resource
to be replaced.
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `addChildHealthCheck`
```typescript
public addChildHealthCheck(healthCheck: IHealthCheck): void
```
###### `healthCheck`Required
- *Type:* IHealthCheck
---
##### `failover`
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
###### `failover`Optional
- *Type:* Failover
---
##### `failoverPrimary`
```typescript
public failoverPrimary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
##### `failoverSecondary`
```typescript
public failoverSecondary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
##### `metric`
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`Required
- *Type:* string
---
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricChildHealthCheckHealthyCount`
```typescript
public metricChildHealthCheckHealthyCount(props?: MetricOptions): Metric
```
The number of ChildHealthChecks that are healthy that Route53 is monitoring.
Valid statistics: Average (recommended), Minimum, Maximum
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus`
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
| isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. |
| isResource | Check whether the given construct is a Resource. |
| fromHealthCheckId | Import an existing Route53 HealthCheck. |
---
##### ~~`isConstruct`~~
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `fromHealthCheckId`
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.fromHealthCheckId(scope: Construct, id: string, healthCheckId: string)
```
Import an existing Route53 HealthCheck.
###### `scope`Required
- *Type:* constructs.Construct
---
###### `id`Required
- *Type:* string
---
###### `healthCheckId`Required
- *Type:* string
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
| healthCheckId | string | *No description.* |
| tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
```
- *Type:* aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK
(generally, those created by creating new class instances like Role, Bucket, etc.),
this is always the same as the environment of the stack they belong to;
however, for imported resources
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
that might be different than the stack they were imported into.
---
##### `stack`Required
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `healthCheckId`Required
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
##### `tags`Required
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
### EndpointHealthCheck
- *Implements:* IHealthCheck, aws-cdk-lib.ITaggable
Create a Route53 HealthCheck that monitors an endpoint either by domain name or by IP address.
Example
```typescript
new EndpointHealthCheck(stack, "HealthCheck", {
domainName: "pepperize.com",
});
```
Generates
```yaml
Resources:
Type: AWS::Route53::HealthCheck
Properties:
HealthCheckConfig:
FullyQualifiedDomainName: "pepperize.com"
Port: 443
Type: "HTTPS"
EnableSNI: true
```
> [https://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#aws-resource-route53-healthcheck-properties](https://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#aws-resource-route53-healthcheck-properties)
#### Initializers
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
new EndpointHealthCheck(scope: Construct, id: string, props: EndpointHealthCheckProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | EndpointHealthCheckProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* EndpointHealthCheckProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| applyRemovalPolicy | Apply the given removal policy to this resource. |
| failover | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| failoverPrimary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| failoverSecondary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| metric | Return the given named metric for this HealthCheck. |
| metricConnectionTime | The time in milliseconds that it took Route53 health checkers to establish a TCP connection with the endpoint. |
| metricHealthCheckPercentageHealthy | The percentage of Route53 health checkers that report that the status of the health check is healthy. |
| metricHealthCheckStatus | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
| metricSSLHandshakeTime | The time in milliseconds that it took Route53 health checkers to complete the SSL/TLS handshake. |
| metricTimeToFirstByte | The time in milliseconds that it took Route53 health checkers to receive the first byte of the response to an HTTP or HTTPS request. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops
being managed by CloudFormation, either because you've removed it from the
CDK application or because you've made a change that requires the resource
to be replaced.
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `failover`
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
###### `failover`Optional
- *Type:* Failover
---
##### `failoverPrimary`
```typescript
public failoverPrimary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
##### `failoverSecondary`
```typescript
public failoverSecondary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
---
##### `metric`
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`Required
- *Type:* string
---
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricConnectionTime`
```typescript
public metricConnectionTime(props?: MetricOptions): Metric
```
The time in milliseconds that it took Route53 health checkers to establish a TCP connection with the endpoint.
Valid statistics: Average (recommended), Minimum, Maximum
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckPercentageHealthy`
```typescript
public metricHealthCheckPercentageHealthy(props?: MetricOptions): Metric
```
The percentage of Route53 health checkers that report that the status of the health check is healthy.
LatencyGraphs has to be enabled
Valid statistics: Average (recommended), Minimum, Maximum
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus`
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricSSLHandshakeTime`
```typescript
public metricSSLHandshakeTime(props?: MetricOptions): Metric
```
The time in milliseconds that it took Route53 health checkers to complete the SSL/TLS handshake.
Valid statistics: Average, Minimum, Maximum
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTimeToFirstByte`
```typescript
public metricTimeToFirstByte(props?: MetricOptions): Metric
```
The time in milliseconds that it took Route53 health checkers to receive the first byte of the response to an HTTP or HTTPS request.
Valid statistics: Average (recommended), Minimum, Maximum
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
| isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. |
| isResource | Check whether the given construct is a Resource. |
| fromHealthCheckId | Import an existing Route53 HealthCheck. |
---
##### ~~`isConstruct`~~
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `fromHealthCheckId`
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.fromHealthCheckId(scope: Construct, id: string, healthCheckId: string)
```
Import an existing Route53 HealthCheck.
###### `scope`Required
- *Type:* constructs.Construct
---
###### `id`Required
- *Type:* string
---
###### `healthCheckId`Required
- *Type:* string
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
| healthCheckId | string | *No description.* |
| tags | aws-cdk-lib.TagManager | TagManager to set, remove and format tags. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
```
- *Type:* aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK
(generally, those created by creating new class instances like Role, Bucket, etc.),
this is always the same as the environment of the stack they belong to;
however, for imported resources
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
that might be different than the stack they were imported into.
---
##### `stack`Required
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `healthCheckId`Required
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
##### `tags`Required
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
## Structs
### AlarmHealthCheckProps
#### Initializer
```typescript
import { AlarmHealthCheckProps } from '@pepperize/cdk-route53-health-check'
const alarmHealthCheckProps: AlarmHealthCheckProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| alarm | aws-cdk-lib.aws_cloudwatch.IAlarm | The alarm that Route53 monitors. |
| healthCheckName | string | The display name of this Route53 HealthCheck. |
| insufficientDataHealthStatus | InsufficientDataHealthStatus | The status to assign to the HealthCheck when CloudWatch has insufficient data about the metric. |
| inverted | boolean | Whether to invert the status of the Route53 health check status. |
---
##### `alarm`Required
```typescript
public readonly alarm: IAlarm;
```
- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
The alarm that Route53 monitors.
---
##### `healthCheckName`Optional
```typescript
public readonly healthCheckName: string;
```
- *Type:* string
The display name of this Route53 HealthCheck.
---
##### `insufficientDataHealthStatus`Optional
```typescript
public readonly insufficientDataHealthStatus: InsufficientDataHealthStatus;
```
- *Type:* InsufficientDataHealthStatus
The status to assign to the HealthCheck when CloudWatch has insufficient data about the metric.
---
##### `inverted`Optional
```typescript
public readonly inverted: boolean;
```
- *Type:* boolean
Whether to invert the status of the Route53 health check status.
---
### CalculatedHealthCheckProps
#### Initializer
```typescript
import { CalculatedHealthCheckProps } from '@pepperize/cdk-route53-health-check'
const calculatedHealthCheckProps: CalculatedHealthCheckProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| childHealthChecks | IHealthCheck[] | The list of HealthCheck that monitors other Route53 HealthChecks. |
| healthCheckName | string | The display name of this Route53 HealthCheck. |
| healthThreshold | number | The number of child HealthChecks that Amazon Route53 must consider healthy. |
| inverted | boolean | Whether to invert the status of the Route53 health check status. |
---
##### `childHealthChecks`Optional
```typescript
public readonly childHealthChecks: IHealthCheck[];
```
- *Type:* IHealthCheck[]
The list of HealthCheck that monitors other Route53 HealthChecks.
---
##### `healthCheckName`Optional
```typescript
public readonly healthCheckName: string;
```
- *Type:* string
The display name of this Route53 HealthCheck.
---
##### `healthThreshold`Optional
```typescript
public readonly healthThreshold: number;
```
- *Type:* number
The number of child HealthChecks that Amazon Route53 must consider healthy.
---
##### `inverted`Optional
```typescript
public readonly inverted: boolean;
```
- *Type:* boolean
Whether to invert the status of the Route53 health check status.
---
### EndpointHealthCheckProps
#### Initializer
```typescript
import { EndpointHealthCheckProps } from '@pepperize/cdk-route53-health-check'
const endpointHealthCheckProps: EndpointHealthCheckProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| domainName | string | The domain name that Route53 performs health checks on. Route53 resolves the IP address and performs the lookup. |
| enableSni | boolean | Specify that Route53 sends the host name for TLS negotiation. |
| failureThreshold | number | 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 | string | The display name of this Route53 HealthCheck. |
| inverted | boolean | Whether to invert the status of the Route53 health check status. |
| ipAddress | string | The ip address that Route53 performs health checks on. Optionally a domain name may be given. |
| latencyGraphs | boolean | 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 | number | The port that Route53 performs health checks. |
| protocol | Protocol | The protocol that Route53 uses to communicate with the endpoint. |
| regions | HealthCheckerRegions[] | The list of regions from which Route53 health checkers check the endpoint. |
| requestInterval | number | 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 | string | The path for HTTP or HTTPS health checks. |
| searchString | string | The search string for HTTP or HTTPS health checks. |
---
##### `domainName`Optional
```typescript
public readonly domainName: string;
```
- *Type:* string
The domain name that Route53 performs health checks on. Route53 resolves the IP address and performs the lookup.
If IP address is given, it's used as the host name.
Either DomainName or IpAddress must be specified
---
##### `enableSni`Optional
```typescript
public readonly enableSni: boolean;
```
- *Type:* boolean
- *Default:* true for HTTPS
Specify that Route53 sends the host name for TLS negotiation.
---
##### `failureThreshold`Optional
```typescript
public readonly failureThreshold: number;
```
- *Type:* number
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.
Provide a number between 1 and 10.
---
##### `healthCheckName`Optional
```typescript
public readonly healthCheckName: string;
```
- *Type:* string
The display name of this Route53 HealthCheck.
---
##### `inverted`Optional
```typescript
public readonly inverted: boolean;
```
- *Type:* boolean
Whether to invert the status of the Route53 health check status.
---
##### `ipAddress`Optional
```typescript
public readonly ipAddress: string;
```
- *Type:* string
The ip address that Route53 performs health checks on. Optionally a domain name may be given.
An IP address must be specified if protocol TCP
---
##### `latencyGraphs`Optional
```typescript
public readonly latencyGraphs: boolean;
```
- *Type:* boolean
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.
Can't be changed after HealthCheck is deployed
---
##### `port`Optional
```typescript
public readonly port: number;
```
- *Type:* number
- *Default:* 80 for HTTP; 443 for HTTPS
The port that Route53 performs health checks.
The port must be between 1 and 65535.
---
##### `protocol`Optional
```typescript
public readonly protocol: Protocol;
```
- *Type:* Protocol
- *Default:* HTTPS
The protocol that Route53 uses to communicate with the endpoint.
An IP address must be specified if protocol TCP
---
##### `regions`Optional
```typescript
public readonly regions: HealthCheckerRegions[];
```
- *Type:* HealthCheckerRegions[]
The list of regions from which Route53 health checkers check the endpoint.
If omitted Route53 performs checks from all health checker regions.
---
##### `requestInterval`Optional
```typescript
public readonly requestInterval: number;
```
- *Type:* number
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.
Each Route53 health checker makes requests at this interval. Provide a number between 10 and 30.
If you choose an interval of 10 and there are 15 health checkers, the endpoint will receive approximately 1 request per second.
Can't be changed after HealthCheck is deployed
---
##### `resourcePath`Optional
```typescript
public readonly resourcePath: string;
```
- *Type:* string
The path for HTTP or HTTPS health checks.
Provide a string between 1 and 255 length.
---
##### `searchString`Optional
```typescript
public readonly searchString: string;
```
- *Type:* string
The search string for HTTP or HTTPS health checks.
Route53 will search in the response body. Provide a string between 1 and 255 length.
---
## Protocols
### IHealthCheck
- *Implemented By:* AlarmHealthCheck, CalculatedHealthCheck, EndpointHealthCheck, IHealthCheck
#### Methods
| **Name** | **Description** |
| --- | --- |
| failover | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| failoverPrimary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| failoverSecondary | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| metric | Return the given named metric for this HealthCheck. |
| metricHealthCheckStatus | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
---
##### `failover`
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
The Route53 RecordSet to configure failover.
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
Inherit the health of the referenced Alias RecordSet Target.
---
###### `failover`Optional
- *Type:* Failover
Sets `PRIMARY` or `SECONDARY` as the value for `Failover` on the given RecordSet.
---
##### `failoverPrimary`
```typescript
public failoverPrimary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
The Route53 RecordSet to configure failover.
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
Inherit the health of the referenced Alias RecordSet Target.
---
##### `failoverSecondary`
```typescript
public failoverSecondary(recordSet: RecordSet, evaluateTargetHealth?: boolean): void
```
Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)
###### `recordSet`Required
- *Type:* aws-cdk-lib.aws_route53.RecordSet
The Route53 RecordSet to configure failover.
---
###### `evaluateTargetHealth`Optional
- *Type:* boolean
Inherit the health of the referenced Alias RecordSet Target.
---
##### `metric`
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`Required
- *Type:* string
---
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus`
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`Optional
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| healthCheckId | string | *No description.* |
---
##### `healthCheckId`Required
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
## Enums
### Failover
#### Members
| **Name** | **Description** |
| --- | --- |
| PRIMARY | The primary record set. |
| SECONDARY | The secondary record set. |
---
##### `PRIMARY`
The primary record set.
---
##### `SECONDARY`
The secondary record set.
---
### HealthCheckerRegions
The regions of health checker from which Route53 performs checks on the endpoint.
#### Members
| **Name** | **Description** |
| --- | --- |
| US_EAST_1 | *No description.* |
| US_WEST_1 | *No description.* |
| US_WEST_2 | *No description.* |
| EU_WEST_1 | *No description.* |
| AP_SOUTHEAST_1 | *No description.* |
| AP_SOUTHEAST_2 | *No description.* |
| AP_NORTHEAST_1 | *No description.* |
| SA_EAST_1 | *No description.* |
---
##### `US_EAST_1`
---
##### `US_WEST_1`
---
##### `US_WEST_2`
---
##### `EU_WEST_1`
---
##### `AP_SOUTHEAST_1`
---
##### `AP_SOUTHEAST_2`
---
##### `AP_NORTHEAST_1`
---
##### `SA_EAST_1`
---
### InsufficientDataHealthStatus
#### Members
| **Name** | **Description** |
| --- | --- |
| HEALTHY | Route53 considers the health check to be healthy. |
| UNHEALTHY | Route53 considers the health check to be unhealthy. |
| LAST_KNOWN_STATUS | Route53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state, otherwise healthy. |
---
##### `HEALTHY`
Route53 considers the health check to be healthy.
---
##### `UNHEALTHY`
Route53 considers the health check to be unhealthy.
---
##### `LAST_KNOWN_STATUS`
Route53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state, otherwise healthy.
---
### Protocol
The protocol that Route53 uses to communicate with the endpoint.
#### Members
| **Name** | **Description** |
| --- | --- |
| HTTP | *No description.* |
| HTTPS | *No description.* |
| TCP | *No description.* |
---
##### `HTTP`
---
##### `HTTPS`
---
##### `TCP`
---