software.amazon.awscdk.services.route53

Class HostedZone

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.route53.HostedZone

All Implemented Interfaces:

IResource, IHostedZone, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

PrivateHostedZone, PublicHostedZone

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.663Z")
 @Stability(value=Stable)
public class HostedZone
extends Resource
implements IHostedZone

Container for records, and records contain information about how to route traffic for a specific domain, such as example.com and its subdomains (acme.example.com, zenith.example.com).

Example:

 HostedZone hostedZone = HostedZone.Builder.create(this, "MyHostedZone").zoneName("example.org").build();
 Metric metric = Metric.Builder.create()
         .namespace("AWS/Route53")
         .metricName("DNSQueries")
         .dimensionsMap(Map.of(
                 "HostedZoneId", hostedZone.getHostedZoneId()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostedZone.Builder A fluent builder for HostedZone.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.route53.IHostedZone

IHostedZone.Jsii$Default, IHostedZone.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	HostedZone(software.constructs.Construct scope, String id, HostedZoneProps props)
protected	HostedZone(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HostedZone(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addVpc(IVpc vpc) Add another VPC to this private hosted zone.
static IHostedZone	fromHostedZoneAttributes(software.constructs.Construct scope, String id, HostedZoneAttributes attrs) Imports a hosted zone from another stack.
static IHostedZone	fromHostedZoneId(software.constructs.Construct scope, String id, String hostedZoneId) Import a Route 53 hosted zone defined either outside the CDK, or in a different CDK stack.
static IHostedZone	fromLookup(software.constructs.Construct scope, String id, HostedZoneProviderProps query) Lookup a hosted zone in the current account/region based on query parameters.
String	getHostedZoneArn() ARN of this hosted zone, such as arn:${Partition}:route53:::hostedzone/${Id}.
String	getHostedZoneId() ID of this hosted zone, such as "Z23ABC4XYZL05B".
List<String>	getHostedZoneNameServers() Returns the set of name servers for the specific hosted zone.
protected List<CfnHostedZone.VPCProperty>	getVpcs() VPCs to which this hosted zone will be added.
String	getZoneName() FQDN of this hosted zone.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HostedZone

protected HostedZone(software.amazon.jsii.JsiiObjectRef objRef)

HostedZone

protected HostedZone(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HostedZone

@Stability(value=Stable)
public HostedZone(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           HostedZoneProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromHostedZoneAttributes

@Stability(value=Stable)
 @NotNull
public static IHostedZone fromHostedZoneAttributes(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      HostedZoneAttributes attrs)

Imports a hosted zone from another stack.

Use when both hosted zone ID and hosted zone name are known.

Parameters:

scope - the parent Construct for this Construct. This parameter is required.

id - the logical name of this Construct. This parameter is required.

attrs - the HostedZoneAttributes (hosted zone ID and hosted zone name). This parameter is required.

fromHostedZoneId

@Stability(value=Stable)
 @NotNull
public static IHostedZone fromHostedZoneId(@NotNull
                                                                              software.constructs.Construct scope,
                                                                              @NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              String hostedZoneId)

Import a Route 53 hosted zone defined either outside the CDK, or in a different CDK stack.

Use when hosted zone ID is known. If a HostedZone is imported with this method the zoneName cannot be referenced. If the zoneName is needed then the HostedZone should be imported with fromHostedZoneAttributes() or fromLookup()

Parameters:

scope - the parent Construct for this Construct. This parameter is required.

id - the logical name of this Construct. This parameter is required.

hostedZoneId - the ID of the hosted zone to import. This parameter is required.

fromLookup

@Stability(value=Stable)
 @NotNull
public static IHostedZone fromLookup(@NotNull
                                                                        software.constructs.Construct scope,
                                                                        @NotNull
                                                                        String id,
                                                                        @NotNull
                                                                        HostedZoneProviderProps query)

Lookup a hosted zone in the current account/region based on query parameters.

Requires environment, you must specify env for the stack.

Use to easily query hosted zones.

Parameters:

scope - This parameter is required.

id - This parameter is required.

query - This parameter is required.

See Also:

https://docs.aws.amazon.com/cdk/latest/guide/environments.html

addVpc

@Stability(value=Stable)
public void addVpc(@NotNull
                                            IVpc vpc)

Add another VPC to this private hosted zone.

Parameters:

vpc - the other VPC to add. This parameter is required.

getHostedZoneArn

@Stability(value=Stable)
 @NotNull
public String getHostedZoneArn()

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

Specified by:

getHostedZoneArn in interface IHostedZone

getHostedZoneId

@Stability(value=Stable)
 @NotNull
public String getHostedZoneId()

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

Specified by:

getHostedZoneId in interface IHostedZone

getVpcs

@Stability(value=Stable)
 @NotNull
protected List<CfnHostedZone.VPCProperty> getVpcs()

VPCs to which this hosted zone will be added.

getZoneName

@Stability(value=Stable)
 @NotNull
public String getZoneName()

FQDN of this hosted zone.

Specified by:

getZoneName in interface IHostedZone

getHostedZoneNameServers

@Stability(value=Stable)
 @Nullable
public List<String> getHostedZoneNameServers()

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.

Specified by:

getHostedZoneNameServers in interface IHostedZone