Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

AWS Classic

v4.30.0 published on Tuesday, Nov 30, 2021 by Pulumi

Zone

Manages a Route53 Hosted Zone. For managing Domain Name System Security Extensions (DNSSEC), see the aws.route53.KeySigningKey and aws.route53.HostedZoneDnsSec resources.

Example Usage

Public Zone

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var primary = new Aws.Route53.Zone("primary", new Aws.Route53.ZoneArgs
        {
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewZone(ctx, "primary", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

primary = aws.route53.Zone("primary")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const primary = new aws.route53.Zone("primary", {});

Public Subdomain Zone

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var main = new Aws.Route53.Zone("main", new Aws.Route53.ZoneArgs
        {
        });
        var dev = new Aws.Route53.Zone("dev", new Aws.Route53.ZoneArgs
        {
            Tags = 
            {
                { "Environment", "dev" },
            },
        });
        var dev_ns = new Aws.Route53.Record("dev-ns", new Aws.Route53.RecordArgs
        {
            ZoneId = main.ZoneId,
            Name = "dev.example.com",
            Type = "NS",
            Ttl = 30,
            Records = dev.NameServers,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := route53.NewZone(ctx, "main", nil)
		if err != nil {
			return err
		}
		dev, err := route53.NewZone(ctx, "dev", &route53.ZoneArgs{
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("dev"),
			},
		})
		if err != nil {
			return err
		}
		_, err = route53.NewRecord(ctx, "dev_ns", &route53.RecordArgs{
			ZoneId:  main.ZoneId,
			Name:    pulumi.String("dev.example.com"),
			Type:    pulumi.String("NS"),
			Ttl:     pulumi.Int(30),
			Records: dev.NameServers,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

main = aws.route53.Zone("main")
dev = aws.route53.Zone("dev", tags={
    "Environment": "dev",
})
dev_ns = aws.route53.Record("dev-ns",
    zone_id=main.zone_id,
    name="dev.example.com",
    type="NS",
    ttl=30,
    records=dev.name_servers)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const main = new aws.route53.Zone("main", {});
const dev = new aws.route53.Zone("dev", {tags: {
    Environment: "dev",
}});
const dev_ns = new aws.route53.Record("dev-ns", {
    zoneId: main.zoneId,
    name: "dev.example.com",
    type: "NS",
    ttl: "30",
    records: dev.nameServers,
});

Private Zone

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @private = new Aws.Route53.Zone("private", new Aws.Route53.ZoneArgs
        {
            Vpcs = 
            {
                new Aws.Route53.Inputs.ZoneVpcArgs
                {
                    VpcId = aws_vpc.Example.Id,
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewZone(ctx, "private", &route53.ZoneArgs{
			Vpcs: route53.ZoneVpcArray{
				&route53.ZoneVpcArgs{
					VpcId: pulumi.Any(aws_vpc.Example.Id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

private = aws.route53.Zone("private", vpcs=[aws.route53.ZoneVpcArgs(
    vpc_id=aws_vpc["example"]["id"],
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _private = new aws.route53.Zone("private", {vpcs: [{
    vpcId: aws_vpc.example.id,
}]});

Create a Zone Resource

new Zone(name: string, args?: ZoneArgs, opts?: CustomResourceOptions);
@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         comment: Optional[str] = None,
         delegation_set_id: Optional[str] = None,
         force_destroy: Optional[bool] = None,
         name: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None,
         vpcs: Optional[Sequence[ZoneVpcArgs]] = None)
@overload
def Zone(resource_name: str,
         args: Optional[ZoneArgs] = None,
         opts: Optional[ResourceOptions] = None)
func NewZone(ctx *Context, name string, args *ZoneArgs, opts ...ResourceOption) (*Zone, error)
public Zone(string name, ZoneArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ZoneArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Zone Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Zone resource accepts the following input properties:

Comment string
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
DelegationSetId string
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
ForceDestroy bool
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
Name string
This is the name of the hosted zone.
Tags Dictionary<string, string>
A mapping of tags to assign to the zone.
Vpcs List<ZoneVpcArgs>
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
Comment string
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
DelegationSetId string
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
ForceDestroy bool
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
Name string
This is the name of the hosted zone.
Tags map[string]string
A mapping of tags to assign to the zone.
Vpcs []ZoneVpcArgs
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
comment string
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
delegationSetId string
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
forceDestroy boolean
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
name string
This is the name of the hosted zone.
tags {[key: string]: string}
A mapping of tags to assign to the zone.
vpcs ZoneVpcArgs[]
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
comment str
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
delegation_set_id str
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
force_destroy bool
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
name str
This is the name of the hosted zone.
tags Mapping[str, str]
A mapping of tags to assign to the zone.
vpcs Sequence[ZoneVpcArgs]
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Zone resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the Hosted Zone.
Id string
The provider-assigned unique ID for this managed resource.
NameServers List<string>
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
ZoneId string
The Hosted Zone ID. This can be referenced by zone records.
Arn string
The Amazon Resource Name (ARN) of the Hosted Zone.
Id string
The provider-assigned unique ID for this managed resource.
NameServers []string
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
ZoneId string
The Hosted Zone ID. This can be referenced by zone records.
arn string
The Amazon Resource Name (ARN) of the Hosted Zone.
id string
The provider-assigned unique ID for this managed resource.
nameServers string[]
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
zoneId string
The Hosted Zone ID. This can be referenced by zone records.
arn str
The Amazon Resource Name (ARN) of the Hosted Zone.
id str
The provider-assigned unique ID for this managed resource.
name_servers Sequence[str]
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
zone_id str
The Hosted Zone ID. This can be referenced by zone records.

Look up an Existing Zone Resource

Get an existing Zone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ZoneState, opts?: CustomResourceOptions): Zone
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        comment: Optional[str] = None,
        delegation_set_id: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        name: Optional[str] = None,
        name_servers: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpcs: Optional[Sequence[ZoneVpcArgs]] = None,
        zone_id: Optional[str] = None) -> Zone
func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string
The Amazon Resource Name (ARN) of the Hosted Zone.
Comment string
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
DelegationSetId string
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
ForceDestroy bool
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
Name string
This is the name of the hosted zone.
NameServers List<string>
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
Tags Dictionary<string, string>
A mapping of tags to assign to the zone.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
Vpcs List<ZoneVpcArgs>
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
ZoneId string
The Hosted Zone ID. This can be referenced by zone records.
Arn string
The Amazon Resource Name (ARN) of the Hosted Zone.
Comment string
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
DelegationSetId string
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
ForceDestroy bool
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
Name string
This is the name of the hosted zone.
NameServers []string
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
Tags map[string]string
A mapping of tags to assign to the zone.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
Vpcs []ZoneVpcArgs
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
ZoneId string
The Hosted Zone ID. This can be referenced by zone records.
arn string
The Amazon Resource Name (ARN) of the Hosted Zone.
comment string
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
delegationSetId string
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
forceDestroy boolean
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
name string
This is the name of the hosted zone.
nameServers string[]
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
tags {[key: string]: string}
A mapping of tags to assign to the zone.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpcs ZoneVpcArgs[]
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
zoneId string
The Hosted Zone ID. This can be referenced by zone records.
arn str
The Amazon Resource Name (ARN) of the Hosted Zone.
comment str
A comment for the hosted zone. Defaults to ‘Managed by Pulumi’.
delegation_set_id str
The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones.
force_destroy bool
Whether to destroy all records (possibly managed outside of this provider) in the zone when destroying the zone.
name str
This is the name of the hosted zone.
name_servers Sequence[str]
A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
tags Mapping[str, str]
A mapping of tags to assign to the zone.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
vpcs Sequence[ZoneVpcArgs]
Configuration block(s) specifying VPC(s) to associate with a private hosted zone. Conflicts with the delegation_set_id argument in this resource and any aws.route53.ZoneAssociation resource specifying the same zone ID. Detailed below.
zone_id str
The Hosted Zone ID. This can be referenced by zone records.

Supporting Types

ZoneVpc

VpcId string
ID of the VPC to associate.
VpcRegion string
Region of the VPC to associate. Defaults to AWS provider region.
VpcId string
ID of the VPC to associate.
VpcRegion string
Region of the VPC to associate. Defaults to AWS provider region.
vpcId string
ID of the VPC to associate.
vpcRegion string
Region of the VPC to associate. Defaults to AWS provider region.
vpc_id str
ID of the VPC to associate.
vpc_region str
Region of the VPC to associate. Defaults to AWS provider region.

Import

Route53 Zones can be imported using the zone id, e.g.,

 $ pulumi import aws:route53/zone:Zone myzone Z1D633PJN98FT9

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.