API.md

API Reference

Constructs

CrossAccountDelegationRole

Initializers

import { CrossAccountDelegationRole } from '@kampus/cdk-constructs'

new CrossAccountDelegationRole(scope: Construct, id: string, props: CrossAccountDelegationRoleProps)

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

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: CrossAccountDelegationRoleProps

---

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 { CrossAccountDelegationRole } from '@kampus/cdk-constructs'

CrossAccountDelegationRole.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.
role	aws-cdk-lib.aws_iam.IRole	No description.
roleArn	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

role^Required

public readonly role: IRole;

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

---

roleArn^Required

public readonly roleArn: string;

• Type: string

---

CrossAccountSubdomain

Initializers

import { CrossAccountSubdomain } from '@kampus/cdk-constructs'

new CrossAccountSubdomain(scope: Construct, id: string, props: CrossAccountSubdomainProps)

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

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: CrossAccountSubdomainProps

---

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 { CrossAccountSubdomain } from '@kampus/cdk-constructs'

CrossAccountSubdomain.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.
certificate	aws-cdk-lib.aws_certificatemanager.ICertificate	No description.
hostedZone	aws-cdk-lib.aws_route53.PublicHostedZone	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

certificate^Required

public readonly certificate: ICertificate;

• Type: aws-cdk-lib.aws_certificatemanager.ICertificate

---

hostedZone^Required

public readonly hostedZone: PublicHostedZone;

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

---

Structs

CrossAccountDelegationRoleProps

Initializer

import { CrossAccountDelegationRoleProps } from '@kampus/cdk-constructs'

const crossAccountDelegationRoleProps: CrossAccountDelegationRoleProps = { ... }

Properties

Name	Type	Description
delegationResourceName	string	No description.
organizationAccountID	string	No description.

---

delegationResourceName^Required

public readonly delegationResourceName: string;

• Type: string

---

organizationAccountID^Required

public readonly organizationAccountID: string;

• Type: string

---

CrossAccountSubdomainProps

Initializer

import { CrossAccountSubdomainProps } from '@kampus/cdk-constructs'

const crossAccountSubdomainProps: CrossAccountSubdomainProps = { ... }

Properties

Name	Type	Description
delegationRole	ICrossAccountDelegationRole	No description.
rootDomain	string	No description.
subdomain	string	No description.
certificateRegion	string	No description.

---

delegationRole^Required

public readonly delegationRole: ICrossAccountDelegationRole;

• Type: ICrossAccountDelegationRole

---

rootDomain^Required

public readonly rootDomain: string;

• Type: string

---

subdomain^Required

public readonly subdomain: string;

• Type: string

---

certificateRegion^Optional

public readonly certificateRegion: string;

• Type: string

---

Protocols

ICrossAccountDelegationRole

• Implemented By: ICrossAccountDelegationRole

Properties

Name	Type	Description
role	aws-cdk-lib.aws_iam.IRole	No description.

---

role^Required

public readonly role: IRole;

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

---