API.md

API Reference

Constructs

SplitHorizonDns

Creates a public and private zone for a given domain name, and creates A records for the given targets.

Initializers

import { SplitHorizonDns } from 'aws-cdk-split-horizon-dns'

new SplitHorizonDns(scope: Construct, id: string, props: ISplitHorizonDnsProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	ISplitHorizonDnsProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: ISplitHorizonDnsProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { SplitHorizonDns } from 'aws-cdk-split-horizon-dns'

SplitHorizonDns.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
publicZone	aws-cdk-lib.aws_route53.IHostedZone	No description.
records	aws-cdk-lib.aws_route53.ARecord[][]	No description.
privateZone	aws-cdk-lib.aws_route53.IHostedZone	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

publicZone^Required

public readonly publicZone: IHostedZone;

• Type: aws-cdk-lib.aws_route53.IHostedZone

---

records^Required

public readonly records: ARecord[][];

• Type: aws-cdk-lib.aws_route53.ARecord[][]

---

privateZone^Optional

public readonly privateZone: IHostedZone;

• Type: aws-cdk-lib.aws_route53.IHostedZone

---

Structs

AliasTarget

Initializer

import { AliasTarget } from 'aws-cdk-split-horizon-dns'

const aliasTarget: AliasTarget = { ... }

Properties

Name	Type	Description
target	aws-cdk-lib.aws_route53.IAliasRecordTarget | string[]	No description.
private	boolean	No description.
public	boolean	No description.
ttl	aws-cdk-lib.Duration	No description.

---

target^Required

public readonly target: IAliasRecordTarget | string[];

• Type: aws-cdk-lib.aws_route53.IAliasRecordTarget | string[]

---

private^Optional

public readonly private: boolean;

• Type: boolean

---

public^Optional

public readonly public: boolean;

• Type: boolean

---

ttl^Optional

public readonly ttl: Duration;

• Type: aws-cdk-lib.Duration

---

Protocols

ISplitHorizonDnsProps

• Implemented By: ISplitHorizonDnsProps

Properties

Name	Type	Description
targets	AliasTarget[]	No description.
zoneName	string	No description.
certAlternateNames	string[]	No description.
disallowPrivateZone	boolean	No description.
existingPrivateZone	aws-cdk-lib.aws_route53.IHostedZone	No description.
existingPublicZone	aws-cdk-lib.aws_route53.IHostedZone	No description.
includeCertificate	boolean	No description.
privateZoneVpcs	aws-cdk-lib.aws_ec2.Vpc[]	No description.
recordName	string	No description.

---

targets^Required

public readonly targets: AliasTarget[];

• Type: AliasTarget[]

---

zoneName^Required

public readonly zoneName: string;

• Type: string

---

certAlternateNames^Optional

public readonly certAlternateNames: string[];

• Type: string[]

---

disallowPrivateZone^Optional

public readonly disallowPrivateZone: boolean;

• Type: boolean

---

existingPrivateZone^Optional

public readonly existingPrivateZone: IHostedZone;

• Type: aws-cdk-lib.aws_route53.IHostedZone

---

existingPublicZone^Optional

public readonly existingPublicZone: IHostedZone;

• Type: aws-cdk-lib.aws_route53.IHostedZone

---

includeCertificate^Optional

public readonly includeCertificate: boolean;

• Type: boolean

---

privateZoneVpcs^Optional

public readonly privateZoneVpcs: Vpc[];

• Type: aws-cdk-lib.aws_ec2.Vpc[]

---

recordName^Optional

public readonly recordName: string;

• Type: string

---