API.md

API Reference

Constructs

CrossAccountRoute53RecordSet

Initializers

import { CrossAccountRoute53RecordSet } from 'cdk-cross-account-route53'

new CrossAccountRoute53RecordSet(scope: Construct, id: string, props: CrossAccountRoute53RecordSetProps)

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

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: CrossAccountRoute53RecordSetProps

---

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 { CrossAccountRoute53RecordSet } from 'cdk-cross-account-route53'

CrossAccountRoute53RecordSet.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.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

CrossAccountRoute53Role

Initializers

import { CrossAccountRoute53Role } from 'cdk-cross-account-route53'

new CrossAccountRoute53Role(scope: Construct, id: string, props: CrossAccountRoute53RoleProps)

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

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: CrossAccountRoute53RoleProps

---

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 { CrossAccountRoute53Role } from 'cdk-cross-account-route53'

CrossAccountRoute53Role.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.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

Structs

CrossAccountRoute53RecordSetProps

Initializer

import { CrossAccountRoute53RecordSetProps } from 'cdk-cross-account-route53'

const crossAccountRoute53RecordSetProps: CrossAccountRoute53RecordSetProps = { ... }

Properties

Name	Type	Description
delegationRoleAccount	string	No description.
delegationRoleName	string	No description.
hostedZoneId	string	No description.
resourceRecordSets	any	No description.

---

delegationRoleAccount^Required

public readonly delegationRoleAccount: string;

• Type: string

---

delegationRoleName^Required

public readonly delegationRoleName: string;

• Type: string

---

hostedZoneId^Required

public readonly hostedZoneId: string;

• Type: string

---

resourceRecordSets^Required

public readonly resourceRecordSets: any;

• Type: any

---

CrossAccountRoute53RoleProps

Initializer

import { CrossAccountRoute53RoleProps } from 'cdk-cross-account-route53'

const crossAccountRoute53RoleProps: CrossAccountRoute53RoleProps = { ... }

Properties

Name	Type	Description
assumedBy	aws-cdk-lib.aws_iam.IPrincipal	No description.
records	CrossAccountRoute53RolePropsRecord[]	No description.
roleName	string	No description.
zone	aws-cdk-lib.aws_route53.IHostedZone	No description.
normaliseDomains	boolean	No description.

---

assumedBy^Required

public readonly assumedBy: IPrincipal;

• Type: aws-cdk-lib.aws_iam.IPrincipal

---

records^Required

public readonly records: CrossAccountRoute53RolePropsRecord[];

• Type: CrossAccountRoute53RolePropsRecord[]

---

roleName^Required

public readonly roleName: string;

• Type: string

---

zone^Required

public readonly zone: IHostedZone;

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

---

normaliseDomains^Optional

public readonly normaliseDomains: boolean;

• Type: boolean

---

CrossAccountRoute53RolePropsRecord

Initializer

import { CrossAccountRoute53RolePropsRecord } from 'cdk-cross-account-route53'

const crossAccountRoute53RolePropsRecord: CrossAccountRoute53RolePropsRecord = { ... }

Properties

Name	Type	Description
domainNames	string | string[]	No description.
actions	string[]	No description.
types	string[]	No description.

---

domainNames^Required

public readonly domainNames: string | string[];

• Type: string | string[]

---

actions^Optional

public readonly actions: string[];

• Type: string[]

---

types^Optional

public readonly types: string[];

• Type: string[]

---