Package software.amazon.awscdk.services.route53

Class PublicHostedZone

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.route53.HostedZone

software.amazon.awscdk.services.route53.PublicHostedZone

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.036Z")
@Stability(Stable)
public class PublicHostedZone
extends HostedZone
implements IPublicHostedZone

Create a Route53 public hosted zone.

Example:

 IHostedZone zoneFromAttributes = PublicHostedZone.fromPublicHostedZoneAttributes(this, "MyZone", PublicHostedZoneAttributes.builder()
         .zoneName("example.com")
         .hostedZoneId("ZOJJZC49E0EPZ")
         .build());
 // Does not know zoneName
 IPublicHostedZone zoneFromId = PublicHostedZone.fromPublicHostedZoneId(this, "MyZone", "ZOJJZC49E0EPZ");
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IHostedZone.Jsii$Default, IHostedZone.Jsii$Proxy

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

IPublicHostedZone.Jsii$Default, IPublicHostedZone.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addDelegation(IPublicHostedZone delegate)	Adds a delegation from this zone to a designated zone.
void	addDelegation(IPublicHostedZone delegate, ZoneDelegationOptions opts)	Adds a delegation from this zone to a designated zone.
void	addVpc(IVpc _vpc)	Add another VPC to this private hosted zone.
static IHostedZone	fromPublicHostedZoneAttributes(software.constructs.Construct scope, String id, PublicHostedZoneAttributes attrs)	Imports a public hosted zone from another stack.
static IPublicHostedZone	fromPublicHostedZoneId(software.constructs.Construct scope, String id, String publicHostedZoneId)	Import a Route 53 public hosted zone defined either outside the CDK, or in a different CDK stack.
Role	getCrossAccountZoneDelegationRole()	Role for cross account zone delegation.

Methods inherited from class software.amazon.awscdk.services.route53.HostedZone

fromHostedZoneAttributes, fromHostedZoneId, fromLookup, getHostedZoneArn, getHostedZoneId, getHostedZoneNameServers, getVpcs, getZoneName

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.route53.IHostedZone

getHostedZoneArn, getHostedZoneId, getHostedZoneNameServers, getZoneName

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

PublicHostedZone

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

PublicHostedZone

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

PublicHostedZone

@Stability(Stable)
public PublicHostedZone(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 PublicHostedZoneProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromPublicHostedZoneAttributes

@Stability(Stable)
@NotNull
public static IHostedZone fromPublicHostedZoneAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 PublicHostedZoneAttributes attrs)

Imports a public 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 PublicHostedZoneAttributes (hosted zone ID and hosted zone name). This parameter is required.

fromPublicHostedZoneId

@Stability(Stable)
@NotNull
public static IPublicHostedZone fromPublicHostedZoneId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String publicHostedZoneId)

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

Parameters:

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

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

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

addDelegation

@Stability(Stable)
public void addDelegation(@NotNull
 IPublicHostedZone delegate,
 @Nullable
 ZoneDelegationOptions opts)

Adds a delegation from this zone to a designated zone.

Parameters:

delegate - the zone being delegated to. This parameter is required.

opts - options for creating the DNS record, if any.

addDelegation

@Stability(Stable)
public void addDelegation(@NotNull
 IPublicHostedZone delegate)

Adds a delegation from this zone to a designated zone.

Parameters:

delegate - the zone being delegated to. This parameter is required.

addVpc

@Stability(Stable)
public void addVpc(@NotNull
 IVpc _vpc)

Add another VPC to this private hosted zone.

Overrides:

addVpc in class HostedZone

Parameters:

_vpc - This parameter is required.

getCrossAccountZoneDelegationRole

@Stability(Stable)
@Nullable
public Role getCrossAccountZoneDelegationRole()

Role for cross account zone delegation.