aws.route53.getZone

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

The following example shows how to get a Hosted Zone from its name and from this data how to create a Record Set.

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const selected = aws.route53.getZone({
    name: "test.com.",
    privateZone: true,
});
const www = new aws.route53.Record("www", {
    zoneId: selected.then(selected => selected.zoneId),
    name: selected.then(selected => `www.${selected.name}`),
    type: aws.route53.RecordType.A,
    ttl: 300,
    records: ["10.0.0.1"],
});

import pulumi
import pulumi_aws as aws

selected = aws.route53.get_zone(name="test.com.",
    private_zone=True)
www = aws.route53.Record("www",
    zone_id=selected.zone_id,
    name=f"www.{selected.name}",
    type=aws.route53.RecordType.A,
    ttl=300,
    records=["10.0.0.1"])

package main

import (
	"fmt"

	"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 {
		selected, err := route53.LookupZone(ctx, &route53.LookupZoneArgs{
			Name:        pulumi.StringRef("test.com."),
			PrivateZone: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = route53.NewRecord(ctx, "www", &route53.RecordArgs{
			ZoneId: pulumi.String(selected.ZoneId),
			Name:   pulumi.Sprintf("www.%v", selected.Name),
			Type:   pulumi.String(route53.RecordTypeA),
			Ttl:    pulumi.Int(300),
			Records: pulumi.StringArray{
				pulumi.String("10.0.0.1"),
			},
		})
		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 selected = Aws.Route53.GetZone.Invoke(new()
    {
        Name = "test.com.",
        PrivateZone = true,
    });

    var www = new Aws.Route53.Record("www", new()
    {
        ZoneId = selected.Apply(getZoneResult => getZoneResult.ZoneId),
        Name = $"www.{selected.Apply(getZoneResult => getZoneResult.Name)}",
        Type = Aws.Route53.RecordType.A,
        Ttl = 300,
        Records = new[]
        {
            "10.0.0.1",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.Route53Functions;
import com.pulumi.aws.route53.inputs.GetZoneArgs;
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) {
        final var selected = Route53Functions.getZone(GetZoneArgs.builder()
            .name("test.com.")
            .privateZone(true)
            .build());

        var www = new Record("www", RecordArgs.builder()
            .zoneId(selected.applyValue(getZoneResult -> getZoneResult.zoneId()))
            .name(String.format("www.%s", selected.applyValue(getZoneResult -> getZoneResult.name())))
            .type("A")
            .ttl("300")
            .records("10.0.0.1")
            .build());

    }
}

resources:
  www:
    type: aws:route53:Record
    properties:
      zoneId: ${selected.zoneId}
      name: www.${selected.name}
      type: A
      ttl: '300'
      records:
        - 10.0.0.1
variables:
  selected:
    fn::invoke:
      function: aws:route53:getZone
      arguments:
        name: test.com.
        privateZone: true

Using getZone

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getZone(args: GetZoneArgs, opts?: InvokeOptions): Promise<GetZoneResult>
function getZoneOutput(args: GetZoneOutputArgs, opts?: InvokeOptions): Output<GetZoneResult>

def get_zone(name: Optional[str] = None,
             private_zone: Optional[bool] = None,
             tags: Optional[Mapping[str, str]] = None,
             vpc_id: Optional[str] = None,
             zone_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetZoneResult
def get_zone_output(name: Optional[pulumi.Input[str]] = None,
             private_zone: Optional[pulumi.Input[bool]] = None,
             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             vpc_id: Optional[pulumi.Input[str]] = None,
             zone_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetZoneResult]

func LookupZone(ctx *Context, args *LookupZoneArgs, opts ...InvokeOption) (*LookupZoneResult, error)
func LookupZoneOutput(ctx *Context, args *LookupZoneOutputArgs, opts ...InvokeOption) LookupZoneResultOutput

> Note: This function is named LookupZone in the Go SDK.

public static class GetZone 
{
    public static Task<GetZoneResult> InvokeAsync(GetZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetZoneResult> Invoke(GetZoneInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)
public static Output<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)

fn::invoke:
  function: aws:route53/getZone:getZone
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Hosted Zone name of the desired Hosted Zone.
PrivateZone bool: Used with name field to get a private Hosted Zone.
Tags Dictionary<string, string>: Used with name field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
VpcId string: Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
ZoneId string: Hosted Zone id of the desired Hosted Zone.

Name string: Hosted Zone name of the desired Hosted Zone.
PrivateZone bool: Used with name field to get a private Hosted Zone.
Tags map[string]string: Used with name field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
VpcId string: Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
ZoneId string: Hosted Zone id of the desired Hosted Zone.

name String: Hosted Zone name of the desired Hosted Zone.
privateZone Boolean: Used with name field to get a private Hosted Zone.
tags Map<String,String>: Used with name field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
vpcId String: Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
zoneId String: Hosted Zone id of the desired Hosted Zone.

name string: Hosted Zone name of the desired Hosted Zone.
privateZone boolean: Used with name field to get a private Hosted Zone.
tags {[key: string]: string}: Used with name field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
vpcId string: Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
zoneId string: Hosted Zone id of the desired Hosted Zone.

name str: Hosted Zone name of the desired Hosted Zone.
private_zone bool: Used with name field to get a private Hosted Zone.
tags Mapping[str, str]: Used with name field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
vpc_id str: Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
zone_id str: Hosted Zone id of the desired Hosted Zone.

name String: Hosted Zone name of the desired Hosted Zone.
privateZone Boolean: Used with name field to get a private Hosted Zone.
tags Map<String>: Used with name field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
vpcId String: Used with name field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
zoneId String: Hosted Zone id of the desired Hosted Zone.

getZone Result

The following output properties are available:

Arn string: ARN of the Hosted Zone.
CallerReference string: Caller Reference of the Hosted Zone.
Comment string: Comment field of the Hosted Zone.
Id string: The provider-assigned unique ID for this managed resource.
LinkedServiceDescription string: The description provided by the service that created the Hosted Zone (e.g., arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).
LinkedServicePrincipal string: The service that created the Hosted Zone (e.g., servicediscovery.amazonaws.com).
Name string: The Hosted Zone name.
NameServers List<string>: List of DNS name servers for the Hosted Zone.
PrimaryNameServer string: The Route 53 name server that created the SOA record.
ResourceRecordSetCount int: The number of Record Set in the Hosted Zone.
Tags Dictionary<string, string>: A map of tags assigned to the Hosted Zone.
VpcId string
ZoneId string: The Hosted Zone identifier.
PrivateZone bool: Indicates whether this is a private hosted zone.

Arn string: ARN of the Hosted Zone.
CallerReference string: Caller Reference of the Hosted Zone.
Comment string: Comment field of the Hosted Zone.
Id string: The provider-assigned unique ID for this managed resource.
LinkedServiceDescription string: The description provided by the service that created the Hosted Zone (e.g., arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).
LinkedServicePrincipal string: The service that created the Hosted Zone (e.g., servicediscovery.amazonaws.com).
Name string: The Hosted Zone name.
NameServers []string: List of DNS name servers for the Hosted Zone.
PrimaryNameServer string: The Route 53 name server that created the SOA record.
ResourceRecordSetCount int: The number of Record Set in the Hosted Zone.
Tags map[string]string: A map of tags assigned to the Hosted Zone.
VpcId string
ZoneId string: The Hosted Zone identifier.
PrivateZone bool: Indicates whether this is a private hosted zone.

arn String: ARN of the Hosted Zone.
callerReference String: Caller Reference of the Hosted Zone.
comment String: Comment field of the Hosted Zone.
id String: The provider-assigned unique ID for this managed resource.
linkedServiceDescription String: The description provided by the service that created the Hosted Zone (e.g., arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).
linkedServicePrincipal String: The service that created the Hosted Zone (e.g., servicediscovery.amazonaws.com).
name String: The Hosted Zone name.
nameServers List<String>: List of DNS name servers for the Hosted Zone.
primaryNameServer String: The Route 53 name server that created the SOA record.
resourceRecordSetCount Integer: The number of Record Set in the Hosted Zone.
tags Map<String,String>: A map of tags assigned to the Hosted Zone.
vpcId String
zoneId String: The Hosted Zone identifier.
privateZone Boolean: Indicates whether this is a private hosted zone.

arn string: ARN of the Hosted Zone.
callerReference string: Caller Reference of the Hosted Zone.
comment string: Comment field of the Hosted Zone.
id string: The provider-assigned unique ID for this managed resource.
linkedServiceDescription string: The description provided by the service that created the Hosted Zone (e.g., arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).
linkedServicePrincipal string: The service that created the Hosted Zone (e.g., servicediscovery.amazonaws.com).
name string: The Hosted Zone name.
nameServers string[]: List of DNS name servers for the Hosted Zone.
primaryNameServer string: The Route 53 name server that created the SOA record.
resourceRecordSetCount number: The number of Record Set in the Hosted Zone.
tags {[key: string]: string}: A map of tags assigned to the Hosted Zone.
vpcId string
zoneId string: The Hosted Zone identifier.
privateZone boolean: Indicates whether this is a private hosted zone.

arn str: ARN of the Hosted Zone.
caller_reference str: Caller Reference of the Hosted Zone.
comment str: Comment field of the Hosted Zone.
id str: The provider-assigned unique ID for this managed resource.
linked_service_description str: The description provided by the service that created the Hosted Zone (e.g., arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).
linked_service_principal str: The service that created the Hosted Zone (e.g., servicediscovery.amazonaws.com).
name str: The Hosted Zone name.
name_servers Sequence[str]: List of DNS name servers for the Hosted Zone.
primary_name_server str: The Route 53 name server that created the SOA record.
resource_record_set_count int: The number of Record Set in the Hosted Zone.
tags Mapping[str, str]: A map of tags assigned to the Hosted Zone.
vpc_id str
zone_id str: The Hosted Zone identifier.
private_zone bool: Indicates whether this is a private hosted zone.

arn String: ARN of the Hosted Zone.
callerReference String: Caller Reference of the Hosted Zone.
comment String: Comment field of the Hosted Zone.
id String: The provider-assigned unique ID for this managed resource.
linkedServiceDescription String: The description provided by the service that created the Hosted Zone (e.g., arn:aws:servicediscovery:us-east-1:1234567890:namespace/ns-xxxxxxxxxxxxxxxx).
linkedServicePrincipal String: The service that created the Hosted Zone (e.g., servicediscovery.amazonaws.com).
name String: The Hosted Zone name.
nameServers List<String>: List of DNS name servers for the Hosted Zone.
primaryNameServer String: The Route 53 name server that created the SOA record.
resourceRecordSetCount Number: The number of Record Set in the Hosted Zone.
tags Map<String>: A map of tags assigned to the Hosted Zone.
vpcId String
zoneId String: The Hosted Zone identifier.
privateZone Boolean: Indicates whether this is a private hosted zone.

Package Details

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

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-aws

aws.route53.getZone

On this page

On this page

Example Usage

Using getZone

getZone Result

Package Details

On this page

On this page