API.md

API Reference

Constructs

CrossAccountHostedZone

• Implements: @aws-cdk/core.ITaggable

Define a Route53 Private Hosted Zone, same as @aws-cdk/aws-route53.PrivateHostedZone, but allows associating the PHZ with VPC(s) in different AWS accounts.

Initializer

import { CrossAccountHostedZone } from '@tomas-mazak/cdk-dns'

new CrossAccountHostedZone(scope: Construct, id: string, props: CrossAccountHostedZoneProps)

scope^Required

• Type: @aws-cdk/core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @tomas-mazak/cdk-dns.CrossAccountHostedZoneProps

---

Properties

tags^Required

• Type: @aws-cdk/core.TagManager

TagManager to set, remove and format tags.

---

Structs

CrossAccountHostedZoneProps

Initializer

import { CrossAccountHostedZoneProps } from '@tomas-mazak/cdk-dns'

const crossAccountHostedZoneProps: CrossAccountHostedZoneProps = { ... }

vpcs^Required

• Type: @tomas-mazak/cdk-dns.CrossAccountVpc[]

VPCs to associate the PHZ with, including the VPC account information (as the VPC can be in a different account than the PHZ itself).

---

zoneName^Required

• Type: string

The name of the domain.

---

comment^Optional

• Type: string

Any comments that you want to include about the hosted zone.

---

zoneAccountRole^Optional

• Type: @aws-cdk/aws-iam.IRole

An IAM role to assume to create the private hosted zone.

Use if the PHZ should be deployed in different account than the CDK stack (default: CDK credentials are directly used)

---

CrossAccountVpc

Initializer

import { CrossAccountVpc } from '@tomas-mazak/cdk-dns'

const crossAccountVpc: CrossAccountVpc = { ... }

vpc^Required

• Type: @aws-cdk/aws-ec2.IVpc

VPCs to associate the PHZ with.

---

vpcAccountRole^Optional

• Type: @aws-cdk/aws-iam.IRole

An IAM role to assume to "switch" to the VPC account, to associate the PHZ with the VPC.

If not specified, CDK credentials will be used directly (that means, CDK must be authenticated to the account where the VPC is)

---