From add97fe2ad6533c3b3acb387d8c37176458b1fe4 Mon Sep 17 00:00:00 2001 From: IamFlowZ Date: Sun, 26 Feb 2023 11:07:35 -0500 Subject: [PATCH] build before push? --- API.md | 75 ++++++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 55 insertions(+), 20 deletions(-) diff --git a/API.md b/API.md index b62e958..8d09e2a 100644 --- a/API.md +++ b/API.md @@ -4,6 +4,8 @@ ### SplitHorizonDns +Creates a public and private zone for a given domain name, and creates A records for the given targets. + #### Initializers ```typescript @@ -85,9 +87,9 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | -| privateZone | aws-cdk-lib.aws_route53.HostedZone | *No description.* | | publicZone | aws-cdk-lib.aws_route53.HostedZone | *No description.* | | records | aws-cdk-lib.aws_route53.ARecord[][] | *No description.* | +| privateZone | aws-cdk-lib.aws_route53.HostedZone | *No description.* | --- @@ -103,33 +105,33 @@ The tree node. --- -##### `privateZone`Required +##### `publicZone`Required ```typescript -public readonly privateZone: HostedZone; +public readonly publicZone: HostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.HostedZone --- -##### `publicZone`Required +##### `records`Required ```typescript -public readonly publicZone: HostedZone; +public readonly records: ARecord[][]; ``` -- *Type:* aws-cdk-lib.aws_route53.HostedZone +- *Type:* aws-cdk-lib.aws_route53.ARecord[][] --- -##### `records`Required +##### `privateZone`Optional ```typescript -public readonly records: ARecord[][]; +public readonly privateZone: HostedZone; ``` -- *Type:* aws-cdk-lib.aws_route53.ARecord[][] +- *Type:* aws-cdk-lib.aws_route53.HostedZone --- @@ -209,21 +211,14 @@ public readonly ttl: Duration; | **Name** | **Type** | **Description** | | --- | --- | --- | -| privateZoneVpcs | aws-cdk-lib.aws_ec2.Vpc[] | *No description.* | | targets | AliasTarget[] | *No description.* | | zoneName | string | *No description.* | | certAlternateNames | string[] | *No description.* | +| disallowPrivateZone | boolean | *No description.* | +| existingPrivateZone | aws-cdk-lib.aws_route53.HostedZone | *No description.* | +| existingPublicZone | aws-cdk-lib.aws_route53.HostedZone | *No description.* | | includeCertificate | boolean | *No description.* | - ---- - -##### `privateZoneVpcs`Required - -```typescript -public readonly privateZoneVpcs: Vpc[]; -``` - -- *Type:* aws-cdk-lib.aws_ec2.Vpc[] +| privateZoneVpcs | aws-cdk-lib.aws_ec2.Vpc[] | *No description.* | --- @@ -257,6 +252,36 @@ public readonly certAlternateNames: string[]; --- +##### `disallowPrivateZone`Optional + +```typescript +public readonly disallowPrivateZone: boolean; +``` + +- *Type:* boolean + +--- + +##### `existingPrivateZone`Optional + +```typescript +public readonly existingPrivateZone: HostedZone; +``` + +- *Type:* aws-cdk-lib.aws_route53.HostedZone + +--- + +##### `existingPublicZone`Optional + +```typescript +public readonly existingPublicZone: HostedZone; +``` + +- *Type:* aws-cdk-lib.aws_route53.HostedZone + +--- + ##### `includeCertificate`Optional ```typescript @@ -267,3 +292,13 @@ public readonly includeCertificate: boolean; --- +##### `privateZoneVpcs`Optional + +```typescript +public readonly privateZoneVpcs: Vpc[]; +``` + +- *Type:* aws-cdk-lib.aws_ec2.Vpc[] + +--- +