aws-cdk-lib.aws_route53.IHostedZone

interface IHostedZone

LanguageType name
.NETAmazon.CDK.AWS.Route53.IHostedZone
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsroute53#IHostedZone
Javasoftware.amazon.awscdk.services.route53.IHostedZone
Pythonaws_cdk.aws_route53.IHostedZone
TypeScript (source)aws-cdk-lib » aws_route53 » IHostedZone

Implemented by HostedZone, PrivateHostedZone, PublicHostedZone

Obtainable from HostedZone.fromHostedZoneAttributes(), HostedZone.fromHostedZoneId(), HostedZone.fromLookup()

Imported or created hosted zone.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
hostedZoneArnstringARN of this hosted zone, such as arn:${Partition}:route53:::hostedzone/${Id}.
hostedZoneIdstringID of this hosted zone, such as "Z23ABC4XYZL05B".
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
zoneNamestringFQDN 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

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

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