1. Packages
  2. AWS Classic
  3. API Docs
  4. route53
  5. Zone

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi

aws.route53.Zone

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const primary = new aws.route53.Zone("primary", {name: "example.com"});
    
    import pulumi
    import pulumi_aws as aws
    
    primary = aws.route53.Zone("primary", name="example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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", &route53.ZoneArgs{
    			Name: pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var primary = new Aws.Route53.Zone("primary", new()
        {
            Name = "example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.route53.Zone;
    import com.pulumi.aws.route53.ZoneArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var primary = new Zone("primary", ZoneArgs.builder()        
                .name("example.com")
                .build());
    
        }
    }
    
    resources:
      primary:
        type: aws:route53:Zone
        properties:
          name: example.com
    

    Public Subdomain Zone

    For use in subdomains, note that you need to create a aws.route53.Record of type NS as well as the subdomain zone.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const main = new aws.route53.Zone("main", {name: "example.com"});
    const dev = new aws.route53.Zone("dev", {
        name: "dev.example.com",
        tags: {
            Environment: "dev",
        },
    });
    const dev_ns = new aws.route53.Record("dev-ns", {
        zoneId: main.zoneId,
        name: "dev.example.com",
        type: aws.route53.RecordType.NS,
        ttl: 30,
        records: dev.nameServers,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    main = aws.route53.Zone("main", name="example.com")
    dev = aws.route53.Zone("dev",
        name="dev.example.com",
        tags={
            "Environment": "dev",
        })
    dev_ns = aws.route53.Record("dev-ns",
        zone_id=main.zone_id,
        name="dev.example.com",
        type=aws.route53.RecordType.NS,
        ttl=30,
        records=dev.name_servers)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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", &route53.ZoneArgs{
    			Name: pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		dev, err := route53.NewZone(ctx, "dev", &route53.ZoneArgs{
    			Name: pulumi.String("dev.example.com"),
    			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(route53.RecordTypeNS),
    			Ttl:     pulumi.Int(30),
    			Records: dev.NameServers,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Aws.Route53.Zone("main", new()
        {
            Name = "example.com",
        });
    
        var dev = new Aws.Route53.Zone("dev", new()
        {
            Name = "dev.example.com",
            Tags = 
            {
                { "Environment", "dev" },
            },
        });
    
        var dev_ns = new Aws.Route53.Record("dev-ns", new()
        {
            ZoneId = main.ZoneId,
            Name = "dev.example.com",
            Type = Aws.Route53.RecordType.NS,
            Ttl = 30,
            Records = dev.NameServers,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.route53.Zone;
    import com.pulumi.aws.route53.ZoneArgs;
    import com.pulumi.aws.route53.Record;
    import com.pulumi.aws.route53.RecordArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var main = new Zone("main", ZoneArgs.builder()        
                .name("example.com")
                .build());
    
            var dev = new Zone("dev", ZoneArgs.builder()        
                .name("dev.example.com")
                .tags(Map.of("Environment", "dev"))
                .build());
    
            var dev_ns = new Record("dev-ns", RecordArgs.builder()        
                .zoneId(main.zoneId())
                .name("dev.example.com")
                .type("NS")
                .ttl("30")
                .records(dev.nameServers())
                .build());
    
        }
    }
    
    resources:
      main:
        type: aws:route53:Zone
        properties:
          name: example.com
      dev:
        type: aws:route53:Zone
        properties:
          name: dev.example.com
          tags:
            Environment: dev
      dev-ns:
        type: aws:route53:Record
        properties:
          zoneId: ${main.zoneId}
          name: dev.example.com
          type: NS
          ttl: '30'
          records: ${dev.nameServers}
    

    Private Zone

    NOTE: This provider provides both exclusive VPC associations defined in-line in this resource via vpc configuration blocks and a separate Zone VPC Association resource. At this time, you cannot use in-line VPC associations in conjunction with any aws.route53.ZoneAssociation resources with the same zone ID otherwise it will cause a perpetual difference in plan output. You can optionally use [ignoreChanges](https://www.pulumi.com/docs/intro/concepts/programming-model/#ignorechanges) to manage additional associations via the aws.route53.ZoneAssociation` resource.

    NOTE: Private zones require at least one VPC association at all times.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const _private = new aws.route53.Zone("private", {
        name: "example.com",
        vpcs: [{
            vpcId: example.id,
        }],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    private = aws.route53.Zone("private",
        name="example.com",
        vpcs=[aws.route53.ZoneVpcArgs(
            vpc_id=example["id"],
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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{
    			Name: pulumi.String("example.com"),
    			Vpcs: route53.ZoneVpcArray{
    				&route53.ZoneVpcArgs{
    					VpcId: pulumi.Any(example.Id),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var @private = new Aws.Route53.Zone("private", new()
        {
            Name = "example.com",
            Vpcs = new[]
            {
                new Aws.Route53.Inputs.ZoneVpcArgs
                {
                    VpcId = example.Id,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.route53.Zone;
    import com.pulumi.aws.route53.ZoneArgs;
    import com.pulumi.aws.route53.inputs.ZoneVpcArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var private_ = new Zone("private", ZoneArgs.builder()        
                .name("example.com")
                .vpcs(ZoneVpcArgs.builder()
                    .vpcId(example.id())
                    .build())
                .build());
    
        }
    }
    
    resources:
      private:
        type: aws:route53:Zone
        properties:
          name: example.com
          vpcs:
            - vpcId: ${example.id}
    

    Create Zone Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Zone(name: string, args?: ZoneArgs, opts?: CustomResourceOptions);
    @overload
    def Zone(resource_name: str,
             args: Optional[ZoneArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @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)
    func NewZone(ctx *Context, name string, args *ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs? args = null, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
    public Zone(String name, ZoneArgs args, CustomResourceOptions options)
    
    type: aws:route53:Zone
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.
    name String
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var zoneResource = new Aws.Route53.Zone("zoneResource", new()
    {
        Comment = "string",
        DelegationSetId = "string",
        ForceDestroy = false,
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Vpcs = new[]
        {
            new Aws.Route53.Inputs.ZoneVpcArgs
            {
                VpcId = "string",
                VpcRegion = "string",
            },
        },
    });
    
    example, err := route53.NewZone(ctx, "zoneResource", &route53.ZoneArgs{
    	Comment:         pulumi.String("string"),
    	DelegationSetId: pulumi.String("string"),
    	ForceDestroy:    pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Vpcs: route53.ZoneVpcArray{
    		&route53.ZoneVpcArgs{
    			VpcId:     pulumi.String("string"),
    			VpcRegion: pulumi.String("string"),
    		},
    	},
    })
    
    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()        
        .comment("string")
        .delegationSetId("string")
        .forceDestroy(false)
        .name("string")
        .tags(Map.of("string", "string"))
        .vpcs(ZoneVpcArgs.builder()
            .vpcId("string")
            .vpcRegion("string")
            .build())
        .build());
    
    zone_resource = aws.route53.Zone("zoneResource",
        comment="string",
        delegation_set_id="string",
        force_destroy=False,
        name="string",
        tags={
            "string": "string",
        },
        vpcs=[aws.route53.ZoneVpcArgs(
            vpc_id="string",
            vpc_region="string",
        )])
    
    const zoneResource = new aws.route53.Zone("zoneResource", {
        comment: "string",
        delegationSetId: "string",
        forceDestroy: false,
        name: "string",
        tags: {
            string: "string",
        },
        vpcs: [{
            vpcId: "string",
            vpcRegion: "string",
        }],
    });
    
    type: aws:route53:Zone
    properties:
        comment: string
        delegationSetId: string
        forceDestroy: false
        name: string
        tags:
            string: string
        vpcs:
            - vpcId: string
              vpcRegion: string
    

    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Vpcs List<ZoneVpc>
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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 Map<String,String>
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcs List<ZoneVpc>
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcs ZoneVpc[]
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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.
    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 Map<String>
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcs List<Property Map>
    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.
    PrimaryNameServer string
    The Route 53 name server that created the SOA record.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    PrimaryNameServer string
    The Route 53 name server that created the SOA record.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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 List<String>
    A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
    primaryNameServer String
    The Route 53 name server that created the SOA record.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    primaryNameServer string
    The Route 53 name server that created the SOA record.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    primary_name_server str
    The Route 53 name server that created the SOA record.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    zone_id str
    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 List<String>
    A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
    primaryNameServer String
    The Route 53 name server that created the SOA record.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    zoneId String
    The Hosted Zone ID. This can be referenced by zone records.

    Look up 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,
            primary_name_server: Optional[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)
    public static Zone get(String name, Output<String> id, ZoneState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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.
    PrimaryNameServer string
    The Route 53 name server that created the SOA record.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Vpcs List<ZoneVpc>
    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.
    PrimaryNameServer string
    The Route 53 name server that created the SOA record.
    Tags map[string]string
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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 List<String>
    A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
    primaryNameServer String
    The Route 53 name server that created the SOA record.
    tags Map<String,String>
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcs List<ZoneVpc>
    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.
    primaryNameServer string
    The Route 53 name server that created the SOA record.
    tags {[key: string]: string}
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcs ZoneVpc[]
    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.
    primary_name_server str
    The Route 53 name server that created the SOA record.
    tags Mapping[str, str]
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    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 List<String>
    A list of name servers in associated (or default) delegation set. Find more about delegation sets in AWS docs.
    primaryNameServer String
    The Route 53 name server that created the SOA record.
    tags Map<String>
    A mapping of tags to assign to the zone. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcs List<Property Map>
    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.

    Supporting Types

    ZoneVpc, ZoneVpcArgs

    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.
    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.
    vpcId String
    ID of the VPC to associate.
    vpcRegion String
    Region of the VPC to associate. Defaults to AWS provider region.

    Import

    Using pulumi import, import Route53 Zones using the zone id. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi