1. Packages
  2. Netlify Provider
  3. API Docs
  4. getDnsZone
netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify.getDnsZone

Explore with Pulumi AI

Example Usage

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

const example = netlify.getDnsZone({
    name: "example.com",
});
Copy
import pulumi
import pulumi_netlify as netlify

example = netlify.get_dns_zone(name="example.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netlify/netlify"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netlify.LookupDnsZone(ctx, &netlify.LookupDnsZoneArgs{
			Name: pulumi.StringRef("example.com"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netlify = Pulumi.Netlify;

return await Deployment.RunAsync(() => 
{
    var example = Netlify.GetDnsZone.Invoke(new()
    {
        Name = "example.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netlify.NetlifyFunctions;
import com.pulumi.netlify.inputs.GetDnsZoneArgs;
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 example = NetlifyFunctions.getDnsZone(GetDnsZoneArgs.builder()
            .name("example.com")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: netlify:getDnsZone
      arguments:
        name: example.com
Copy

Using getDnsZone

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.

function getDnsZone(args: GetDnsZoneArgs, opts?: InvokeOptions): Promise<GetDnsZoneResult>
function getDnsZoneOutput(args: GetDnsZoneOutputArgs, opts?: InvokeOptions): Output<GetDnsZoneResult>
Copy
def get_dns_zone(id: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDnsZoneResult
def get_dns_zone_output(id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDnsZoneResult]
Copy
func LookupDnsZone(ctx *Context, args *LookupDnsZoneArgs, opts ...InvokeOption) (*LookupDnsZoneResult, error)
func LookupDnsZoneOutput(ctx *Context, args *LookupDnsZoneOutputArgs, opts ...InvokeOption) LookupDnsZoneResultOutput
Copy

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

public static class GetDnsZone 
{
    public static Task<GetDnsZoneResult> InvokeAsync(GetDnsZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetDnsZoneResult> Invoke(GetDnsZoneInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDnsZoneResult> getDnsZone(GetDnsZoneArgs args, InvokeOptions options)
public static Output<GetDnsZoneResult> getDnsZone(GetDnsZoneArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netlify:index/getDnsZone:getDnsZone
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of this resource.
Name string
Id string
The ID of this resource.
Name string
id String
The ID of this resource.
name String
id string
The ID of this resource.
name string
id str
The ID of this resource.
name str
id String
The ID of this resource.
name String

getDnsZone Result

The following output properties are available:

DnsServers List<string>
Domain GetDnsZoneDomain
Id string
The ID of this resource.
Name string
Records List<GetDnsZoneRecord>
TeamId string
TeamSlug string
DnsServers []string
Domain GetDnsZoneDomain
Id string
The ID of this resource.
Name string
Records []GetDnsZoneRecord
TeamId string
TeamSlug string
dnsServers List<String>
domain GetDnsZoneDomain
id String
The ID of this resource.
name String
records List<GetDnsZoneRecord>
teamId String
teamSlug String
dnsServers string[]
domain GetDnsZoneDomain
id string
The ID of this resource.
name string
records GetDnsZoneRecord[]
teamId string
teamSlug string
dnsServers List<String>
domain Property Map
id String
The ID of this resource.
name String
records List<Property Map>
teamId String
teamSlug String

Supporting Types

GetDnsZoneDomain

AutoRenew This property is required. bool
AutoRenewAt This property is required. string
ExpiresAt This property is required. string
Id This property is required. string
Name This property is required. string
RegisteredAt This property is required. string
RenewalPrice This property is required. string
AutoRenew This property is required. bool
AutoRenewAt This property is required. string
ExpiresAt This property is required. string
Id This property is required. string
Name This property is required. string
RegisteredAt This property is required. string
RenewalPrice This property is required. string
autoRenew This property is required. Boolean
autoRenewAt This property is required. String
expiresAt This property is required. String
id This property is required. String
name This property is required. String
registeredAt This property is required. String
renewalPrice This property is required. String
autoRenew This property is required. boolean
autoRenewAt This property is required. string
expiresAt This property is required. string
id This property is required. string
name This property is required. string
registeredAt This property is required. string
renewalPrice This property is required. string
auto_renew This property is required. bool
auto_renew_at This property is required. str
expires_at This property is required. str
id This property is required. str
name This property is required. str
registered_at This property is required. str
renewal_price This property is required. str
autoRenew This property is required. Boolean
autoRenewAt This property is required. String
expiresAt This property is required. String
id This property is required. String
name This property is required. String
registeredAt This property is required. String
renewalPrice This property is required. String

GetDnsZoneRecord

Flag This property is required. double
Hostname This property is required. string
Id This property is required. string
Priority This property is required. double
Tag This property is required. string
Ttl This property is required. double
Type This property is required. string
Value This property is required. string
Flag This property is required. float64
Hostname This property is required. string
Id This property is required. string
Priority This property is required. float64
Tag This property is required. string
Ttl This property is required. float64
Type This property is required. string
Value This property is required. string
flag This property is required. Double
hostname This property is required. String
id This property is required. String
priority This property is required. Double
tag This property is required. String
ttl This property is required. Double
type This property is required. String
value This property is required. String
flag This property is required. number
hostname This property is required. string
id This property is required. string
priority This property is required. number
tag This property is required. string
ttl This property is required. number
type This property is required. string
value This property is required. string
flag This property is required. float
hostname This property is required. str
id This property is required. str
priority This property is required. float
tag This property is required. str
ttl This property is required. float
type This property is required. str
value This property is required. str
flag This property is required. Number
hostname This property is required. String
id This property is required. String
priority This property is required. Number
tag This property is required. String
ttl This property is required. Number
type This property is required. String
value This property is required. String

Package Details

Repository
netlify netlify/terraform-provider-netlify
License
Notes
This Pulumi package is based on the netlify Terraform Provider.