software.amazon.awscdk.services.route53

Class PublicHostedZone

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.route53.HostedZone

software.amazon.awscdk.services.route53.PublicHostedZone

All Implemented Interfaces:

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

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

Create a Route53 public hosted zone.

Example:

 PublicHostedZone subZone = PublicHostedZone.Builder.create(this, "SubZone")
         .zoneName("sub.someexample.com")
         .build();
 // import the delegation role by constructing the roleArn
 String delegationRoleArn = Stack.of(this).formatArn(ArnComponents.builder()
         .region("") // IAM is global in each partition
         .service("iam")
         .account("parent-account-id")
         .resource("role")
         .resourceName("MyDelegationRole")
         .build());
 IRole delegationRole = Role.fromRoleArn(this, "DelegationRole", delegationRoleArn);
 // create the record
 // create the record
 CrossAccountZoneDelegationRecord.Builder.create(this, "delegate")
         .delegatedZone(subZone)
         .parentHostedZoneName("someexample.com") // or you can use parentHostedZoneId
         .delegationRole(delegationRole)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.services.route53.IPublicHostedZone

IPublicHostedZone.Jsii$Default, IPublicHostedZone.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 IPublicHostedZone	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.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.services.route53.IHostedZone

getHostedZoneArn, getHostedZoneId, getHostedZoneNameServers, getZoneName

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

PublicHostedZone

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

PublicHostedZone

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

PublicHostedZone

@Stability(value=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 Detail

fromPublicHostedZoneAttributes

@Stability(value=Stable)
 @NotNull
public static IPublicHostedZone 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(value=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.

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

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(value=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(value=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(value=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(value=Stable)
 @Nullable
public Role getCrossAccountZoneDelegationRole()

Role for cross account zone delegation.