@pepperize/cdk-route53-health-check
Version:
Create Route53 HealthChecks to monitor TCP, HTTP, HTTPS endpoints, CloudWatch Alarms and other Route53 HealthChecks.
1,207 lines (726 loc) • 78 kB
Markdown
# API Reference <a name="API Reference" id="api-reference"></a>
## Constructs <a name="Constructs" id="Constructs"></a>
### AlarmHealthCheck <a name="AlarmHealthCheck" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck"></a>
- *Implements:* <a href="#@pepperize/cdk-route53-health-check.IHealthCheck">IHealthCheck</a>, aws-cdk-lib.ITaggable
Create a Route53 HealthCheck that monitors a CloudWatch Alarm.
<b>Example</b>
```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 <a name="Initializers" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer"></a>
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
new AlarmHealthCheck(scope: Construct, id: string, props: AlarmHealthCheckProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheckProps">AlarmHealthCheckProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer.parameter.id"></a>
- *Type:* string
---
##### `props`<sup>Required</sup> <a name="props" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.Initializer.parameter.props"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheckProps">AlarmHealthCheckProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.failover">failover</a></code> | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverPrimary">failoverPrimary</a></code> | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverSecondary">failoverSecondary</a></code> | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.metric">metric</a></code> | Return the given named metric for this HealthCheck. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.metricHealthCheckStatus">metricHealthCheckStatus</a></code> | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
---
##### `toString` <a name="toString" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.applyRemovalPolicy"></a>
```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`<sup>Required</sup> <a name="policy" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.applyRemovalPolicy.parameter.policy"></a>
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `failover` <a name="failover" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failover"></a>
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failover.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failover.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
###### `failover`<sup>Optional</sup> <a name="failover" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failover.parameter.failover"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.Failover">Failover</a>
---
##### `failoverPrimary` <a name="failoverPrimary" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverPrimary"></a>
```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`.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverPrimary.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverPrimary.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
##### `failoverSecondary` <a name="failoverSecondary" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverSecondary"></a>
```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`.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverSecondary.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.failoverSecondary.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
##### `metric` <a name="metric" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.metric"></a>
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`<sup>Required</sup> <a name="metricName" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.metric.parameter.metricName"></a>
- *Type:* string
---
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.metric.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus` <a name="metricHealthCheckStatus" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.metricHealthCheckStatus"></a>
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.metricHealthCheckStatus.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.fromHealthCheckId">fromHealthCheckId</a></code> | Import an existing Route53 HealthCheck. |
---
##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.isConstruct"></a>
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`<sup>Required</sup> <a name="x" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
##### `isOwnedResource` <a name="isOwnedResource" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.isOwnedResource"></a>
```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`<sup>Required</sup> <a name="construct" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.isOwnedResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `isResource` <a name="isResource" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.isResource"></a>
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`<sup>Required</sup> <a name="construct" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.isResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `fromHealthCheckId` <a name="fromHealthCheckId" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.fromHealthCheckId"></a>
```typescript
import { AlarmHealthCheck } from '@pepperize/cdk-route53-health-check'
AlarmHealthCheck.fromHealthCheckId(scope: Construct, id: string, healthCheckId: string)
```
Import an existing Route53 HealthCheck.
###### `scope`<sup>Required</sup> <a name="scope" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.fromHealthCheckId.parameter.scope"></a>
- *Type:* constructs.Construct
---
###### `id`<sup>Required</sup> <a name="id" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.fromHealthCheckId.parameter.id"></a>
- *Type:* string
---
###### `healthCheckId`<sup>Required</sup> <a name="healthCheckId" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.fromHealthCheckId.parameter.healthCheckId"></a>
- *Type:* string
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.healthCheckId">healthCheckId</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | TagManager to set, remove and format tags. |
---
##### `node`<sup>Required</sup> <a name="node" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`<sup>Required</sup> <a name="env" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.env"></a>
```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`<sup>Required</sup> <a name="stack" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.stack"></a>
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `healthCheckId`<sup>Required</sup> <a name="healthCheckId" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.healthCheckId"></a>
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
##### `tags`<sup>Required</sup> <a name="tags" id="@pepperize/cdk-route53-health-check.AlarmHealthCheck.property.tags"></a>
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
### CalculatedHealthCheck <a name="CalculatedHealthCheck" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck"></a>
- *Implements:* <a href="#@pepperize/cdk-route53-health-check.IHealthCheck">IHealthCheck</a>, aws-cdk-lib.ITaggable
Create a Route53 HealthCheck that monitors other Route53 HealthChecks.
<b>Example</b>
```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 <a name="Initializers" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer"></a>
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
new CalculatedHealthCheck(scope: Construct, id: string, props: CalculatedHealthCheckProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheckProps">CalculatedHealthCheckProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer.parameter.id"></a>
- *Type:* string
---
##### `props`<sup>Required</sup> <a name="props" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.Initializer.parameter.props"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheckProps">CalculatedHealthCheckProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.addChildHealthCheck">addChildHealthCheck</a></code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failover">failover</a></code> | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverPrimary">failoverPrimary</a></code> | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverSecondary">failoverSecondary</a></code> | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metric">metric</a></code> | Return the given named metric for this HealthCheck. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metricChildHealthCheckHealthyCount">metricChildHealthCheckHealthyCount</a></code> | The number of ChildHealthChecks that are healthy that Route53 is monitoring. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metricHealthCheckStatus">metricHealthCheckStatus</a></code> | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
---
##### `toString` <a name="toString" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.applyRemovalPolicy"></a>
```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`<sup>Required</sup> <a name="policy" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.applyRemovalPolicy.parameter.policy"></a>
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `addChildHealthCheck` <a name="addChildHealthCheck" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.addChildHealthCheck"></a>
```typescript
public addChildHealthCheck(healthCheck: IHealthCheck): void
```
###### `healthCheck`<sup>Required</sup> <a name="healthCheck" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.addChildHealthCheck.parameter.healthCheck"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.IHealthCheck">IHealthCheck</a>
---
##### `failover` <a name="failover" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failover"></a>
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failover.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failover.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
###### `failover`<sup>Optional</sup> <a name="failover" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failover.parameter.failover"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.Failover">Failover</a>
---
##### `failoverPrimary` <a name="failoverPrimary" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverPrimary"></a>
```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`.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverPrimary.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverPrimary.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
##### `failoverSecondary` <a name="failoverSecondary" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverSecondary"></a>
```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`.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverSecondary.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.failoverSecondary.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
##### `metric` <a name="metric" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metric"></a>
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`<sup>Required</sup> <a name="metricName" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metric.parameter.metricName"></a>
- *Type:* string
---
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metric.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricChildHealthCheckHealthyCount` <a name="metricChildHealthCheckHealthyCount" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metricChildHealthCheckHealthyCount"></a>
```typescript
public metricChildHealthCheckHealthyCount(props?: MetricOptions): Metric
```
The number of ChildHealthChecks that are healthy that Route53 is monitoring.
Valid statistics: Average (recommended), Minimum, Maximum
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metricChildHealthCheckHealthyCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus` <a name="metricHealthCheckStatus" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metricHealthCheckStatus"></a>
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.metricHealthCheckStatus.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.fromHealthCheckId">fromHealthCheckId</a></code> | Import an existing Route53 HealthCheck. |
---
##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isConstruct"></a>
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`<sup>Required</sup> <a name="x" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
##### `isOwnedResource` <a name="isOwnedResource" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isOwnedResource"></a>
```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`<sup>Required</sup> <a name="construct" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isOwnedResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `isResource` <a name="isResource" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isResource"></a>
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`<sup>Required</sup> <a name="construct" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.isResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `fromHealthCheckId` <a name="fromHealthCheckId" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.fromHealthCheckId"></a>
```typescript
import { CalculatedHealthCheck } from '@pepperize/cdk-route53-health-check'
CalculatedHealthCheck.fromHealthCheckId(scope: Construct, id: string, healthCheckId: string)
```
Import an existing Route53 HealthCheck.
###### `scope`<sup>Required</sup> <a name="scope" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.fromHealthCheckId.parameter.scope"></a>
- *Type:* constructs.Construct
---
###### `id`<sup>Required</sup> <a name="id" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.fromHealthCheckId.parameter.id"></a>
- *Type:* string
---
###### `healthCheckId`<sup>Required</sup> <a name="healthCheckId" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.fromHealthCheckId.parameter.healthCheckId"></a>
- *Type:* string
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.healthCheckId">healthCheckId</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | TagManager to set, remove and format tags. |
---
##### `node`<sup>Required</sup> <a name="node" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`<sup>Required</sup> <a name="env" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.env"></a>
```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`<sup>Required</sup> <a name="stack" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.stack"></a>
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `healthCheckId`<sup>Required</sup> <a name="healthCheckId" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.healthCheckId"></a>
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
##### `tags`<sup>Required</sup> <a name="tags" id="@pepperize/cdk-route53-health-check.CalculatedHealthCheck.property.tags"></a>
```typescript
public readonly tags: TagManager;
```
- *Type:* aws-cdk-lib.TagManager
TagManager to set, remove and format tags.
---
### EndpointHealthCheck <a name="EndpointHealthCheck" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck"></a>
- *Implements:* <a href="#@pepperize/cdk-route53-health-check.IHealthCheck">IHealthCheck</a>, aws-cdk-lib.ITaggable
Create a Route53 HealthCheck that monitors an endpoint either by domain name or by IP address.
<b>Example</b>
```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 <a name="Initializers" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer"></a>
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
new EndpointHealthCheck(scope: Construct, id: string, props: EndpointHealthCheckProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer.parameter.props">props</a></code> | <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheckProps">EndpointHealthCheckProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer.parameter.id"></a>
- *Type:* string
---
##### `props`<sup>Required</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.Initializer.parameter.props"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheckProps">EndpointHealthCheckProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.failover">failover</a></code> | Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverPrimary">failoverPrimary</a></code> | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverSecondary">failoverSecondary</a></code> | Sets `PRIMARY` as the value for `Failover` on the given RecordSet. Additionally, sets `this.healthCheckId` as the value for `HealthCheckId`. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.metric">metric</a></code> | Return the given named metric for this HealthCheck. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricConnectionTime">metricConnectionTime</a></code> | The time in milliseconds that it took Route53 health checkers to establish a TCP connection with the endpoint. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricHealthCheckPercentageHealthy">metricHealthCheckPercentageHealthy</a></code> | The percentage of Route53 health checkers that report that the status of the health check is healthy. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricHealthCheckStatus">metricHealthCheckStatus</a></code> | Route53 health checkers report that the HealthCheck is healthy or unhealthy. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricSSLHandshakeTime">metricSSLHandshakeTime</a></code> | The time in milliseconds that it took Route53 health checkers to complete the SSL/TLS handshake. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricTimeToFirstByte">metricTimeToFirstByte</a></code> | 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` <a name="toString" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.applyRemovalPolicy"></a>
```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`<sup>Required</sup> <a name="policy" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.applyRemovalPolicy.parameter.policy"></a>
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `failover` <a name="failover" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failover"></a>
```typescript
public failover(recordSet: RecordSet, evaluateTargetHealth?: boolean, failover?: Failover): void
```
Sets `this.healthCheckId` as the value for `HealthCheckId` on the given RecordSet.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failover.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failover.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
###### `failover`<sup>Optional</sup> <a name="failover" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failover.parameter.failover"></a>
- *Type:* <a href="#@pepperize/cdk-route53-health-check.Failover">Failover</a>
---
##### `failoverPrimary` <a name="failoverPrimary" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverPrimary"></a>
```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`.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverPrimary.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverPrimary.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
##### `failoverSecondary` <a name="failoverSecondary" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverSecondary"></a>
```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`.
<b>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets</b>
###### `recordSet`<sup>Required</sup> <a name="recordSet" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverSecondary.parameter.recordSet"></a>
- *Type:* aws-cdk-lib.aws_route53.RecordSet
---
###### `evaluateTargetHealth`<sup>Optional</sup> <a name="evaluateTargetHealth" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.failoverSecondary.parameter.evaluateTargetHealth"></a>
- *Type:* boolean
---
##### `metric` <a name="metric" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metric"></a>
```typescript
public metric(metricName: string, props?: MetricOptions): Metric
```
Return the given named metric for this HealthCheck.
###### `metricName`<sup>Required</sup> <a name="metricName" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metric.parameter.metricName"></a>
- *Type:* string
---
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metric.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricConnectionTime` <a name="metricConnectionTime" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricConnectionTime"></a>
```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`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricConnectionTime.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckPercentageHealthy` <a name="metricHealthCheckPercentageHealthy" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricHealthCheckPercentageHealthy"></a>
```typescript
public metricHealthCheckPercentageHealthy(props?: MetricOptions): Metric
```
The percentage of Route53 health checkers that report that the status of the health check is healthy.
<b>LatencyGraphs has to be enabled</b>
Valid statistics: Average (recommended), Minimum, Maximum
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricHealthCheckPercentageHealthy.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHealthCheckStatus` <a name="metricHealthCheckStatus" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricHealthCheckStatus"></a>
```typescript
public metricHealthCheckStatus(props?: MetricOptions): Metric
```
Route53 health checkers report that the HealthCheck is healthy or unhealthy.
###### `props`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricHealthCheckStatus.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricSSLHandshakeTime` <a name="metricSSLHandshakeTime" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricSSLHandshakeTime"></a>
```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`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricSSLHandshakeTime.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTimeToFirstByte` <a name="metricTimeToFirstByte" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricTimeToFirstByte"></a>
```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`<sup>Optional</sup> <a name="props" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.metricTimeToFirstByte.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.fromHealthCheckId">fromHealthCheckId</a></code> | Import an existing Route53 HealthCheck. |
---
##### ~~`isConstruct`~~ <a name="isConstruct" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.isConstruct"></a>
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`<sup>Required</sup> <a name="x" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
##### `isOwnedResource` <a name="isOwnedResource" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.isOwnedResource"></a>
```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`<sup>Required</sup> <a name="construct" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.isOwnedResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `isResource` <a name="isResource" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.isResource"></a>
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`<sup>Required</sup> <a name="construct" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.isResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `fromHealthCheckId` <a name="fromHealthCheckId" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.fromHealthCheckId"></a>
```typescript
import { EndpointHealthCheck } from '@pepperize/cdk-route53-health-check'
EndpointHealthCheck.fromHealthCheckId(scope: Construct, id: string, healthCheckId: string)
```
Import an existing Route53 HealthCheck.
###### `scope`<sup>Required</sup> <a name="scope" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.fromHealthCheckId.parameter.scope"></a>
- *Type:* constructs.Construct
---
###### `id`<sup>Required</sup> <a name="id" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.fromHealthCheckId.parameter.id"></a>
- *Type:* string
---
###### `healthCheckId`<sup>Required</sup> <a name="healthCheckId" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.fromHealthCheckId.parameter.healthCheckId"></a>
- *Type:* string
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.healthCheckId">healthCheckId</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | TagManager to set, remove and format tags. |
---
##### `node`<sup>Required</sup> <a name="node" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`<sup>Required</sup> <a name="env" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.env"></a>
```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`<sup>Required</sup> <a name="stack" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.stack"></a>
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `healthCheckId`<sup>Required</sup> <a name="healthCheckId" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.property.healthCheckId"></a>
```typescript
public readonly healthCheckId: string;
```
- *Type:* string
---
##### `tags`<sup>Required</sup> <a name="tags" id="@pepperize/cdk-route53-health-check.EndpointHealthCheck.propert