interface IPrivateHostedZone

Language	Type name
.NET	Amazon.CDK.AWS.Route53.IPrivateHostedZone
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsroute53#IPrivateHostedZone
Java	software.amazon.awscdk.services.route53.IPrivateHostedZone
Python	aws_cdk.aws_route53.IPrivateHostedZone
TypeScript (source)	aws-cdk-lib » aws_route53 » IPrivateHostedZone

Implemented by PrivateHostedZone

Obtainable from PrivateHostedZone.fromPrivateHostedZoneId()

Represents a Route 53 private hosted zone.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
hostedZoneArn	string	ARN of this hosted zone, such as arn:${Partition}:route53:::hostedzone/${Id}.
hostedZoneId	string	ID of this hosted zone, such as "Z23ABC4XYZL05B".
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
zoneName	string	FQDN of this hosted zone.
hostedZoneNameServers?	string[]	Returns the set of name servers for the specific hosted zone. For example: ns1.example.com.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

hostedZoneArn

Type: string

ARN of this hosted zone, such as arn:${Partition}:route53:::hostedzone/${Id}.

---

hostedZoneId

Type: string

ID of this hosted zone, such as "Z23ABC4XYZL05B".

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

zoneName

Type: string

FQDN of this hosted zone.

---

hostedZoneNameServers?

Type: string[] (optional)

Returns the set of name servers for the specific hosted zone. For example: ns1.example.com.

This attribute will be undefined for private hosted zones or hosted zones imported from another stack.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantDelegation(grantee)	Grant permissions to add delegation records to this zone.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantDelegation(grantee)

public grantDelegation(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant permissions to add delegation records to this zone.