netlify 0.2.2, Mar 7 25

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify.DnsZone

Explore with Pulumi AI

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

Example Usage

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

const example = new netlify.DnsZone("example", {teamSlug: data.netlify_team.team.slug});

import pulumi
import pulumi_netlify as netlify

example = netlify.DnsZone("example", team_slug=data["netlify_team"]["team"]["slug"])

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.NewDnsZone(ctx, "example", &netlify.DnsZoneArgs{
			TeamSlug: pulumi.Any(data.Netlify_team.Team.Slug),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netlify = Pulumi.Netlify;

return await Deployment.RunAsync(() => 
{
    var example = new Netlify.DnsZone("example", new()
    {
        TeamSlug = data.Netlify_team.Team.Slug,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netlify.DnsZone;
import com.pulumi.netlify.DnsZoneArgs;
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 example = new DnsZone("example", DnsZoneArgs.builder()
            .teamSlug(data.netlify_team().team().slug())
            .build());

    }
}

resources:
  example:
    type: netlify:DnsZone
    properties:
      teamSlug: ${data.netlify_team.team.slug}

Create DnsZone Resource

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

Constructor syntax

new DnsZone(name: string, args?: DnsZoneArgs, opts?: CustomResourceOptions);

@overload
def DnsZone(resource_name: str,
            args: Optional[DnsZoneArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def DnsZone(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            team_slug: Optional[str] = None)

func NewDnsZone(ctx *Context, name string, args *DnsZoneArgs, opts ...ResourceOption) (*DnsZone, error)

public DnsZone(string name, DnsZoneArgs? args = null, CustomResourceOptions? opts = null)

public DnsZone(String name, DnsZoneArgs args)
public DnsZone(String name, DnsZoneArgs args, CustomResourceOptions options)

type: netlify:DnsZone
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 DnsZoneArgs: 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 DnsZoneArgs: 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 DnsZoneArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DnsZoneArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DnsZoneArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

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

var dnsZoneResource = new Netlify.DnsZone("dnsZoneResource", new()
{
    Name = "string",
    TeamSlug = "string",
});

example, err := netlify.NewDnsZone(ctx, "dnsZoneResource", &netlify.DnsZoneArgs{
Name: pulumi.String("string"),
TeamSlug: pulumi.String("string"),
})

var dnsZoneResource = new DnsZone("dnsZoneResource", DnsZoneArgs.builder()
    .name("string")
    .teamSlug("string")
    .build());

dns_zone_resource = netlify.DnsZone("dnsZoneResource",
    name="string",
    team_slug="string")

const dnsZoneResource = new netlify.DnsZone("dnsZoneResource", {
    name: "string",
    teamSlug: "string",
});

type: netlify:DnsZone
properties:
    name: string
    teamSlug: string

DnsZone Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DnsZone resource accepts the following input properties:

Name string
TeamSlug string: Required if a default team was not configured in the provider configuration.

Name string
TeamSlug string: Required if a default team was not configured in the provider configuration.

name String
teamSlug String: Required if a default team was not configured in the provider configuration.

name string
teamSlug string: Required if a default team was not configured in the provider configuration.

name str
team_slug str: Required if a default team was not configured in the provider configuration.

name String
teamSlug String: Required if a default team was not configured in the provider configuration.

Outputs

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

DnsServers List<string>
Domain DnsZoneDomain
Id string: The provider-assigned unique ID for this managed resource.
LastUpdated string
TeamId string

DnsServers []string
Domain DnsZoneDomain
Id string: The provider-assigned unique ID for this managed resource.
LastUpdated string
TeamId string

dnsServers List<String>
domain DnsZoneDomain
id String: The provider-assigned unique ID for this managed resource.
lastUpdated String
teamId String

dnsServers string[]
domain DnsZoneDomain
id string: The provider-assigned unique ID for this managed resource.
lastUpdated string
teamId string

dns_servers Sequence[str]
domain DnsZoneDomain
id str: The provider-assigned unique ID for this managed resource.
last_updated str
team_id str

dnsServers List<String>
domain Property Map
id String: The provider-assigned unique ID for this managed resource.
lastUpdated String
teamId String

Look up Existing DnsZone Resource

Get an existing DnsZone 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?: DnsZoneState, opts?: CustomResourceOptions): DnsZone

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_servers: Optional[Sequence[str]] = None,
        domain: Optional[DnsZoneDomainArgs] = None,
        last_updated: Optional[str] = None,
        name: Optional[str] = None,
        team_id: Optional[str] = None,
        team_slug: Optional[str] = None) -> DnsZone

func GetDnsZone(ctx *Context, name string, id IDInput, state *DnsZoneState, opts ...ResourceOption) (*DnsZone, error)

public static DnsZone Get(string name, Input<string> id, DnsZoneState? state, CustomResourceOptions? opts = null)

public static DnsZone get(String name, Output<String> id, DnsZoneState state, CustomResourceOptions options)

resources:  _:    type: netlify:DnsZone    get:      id: ${id}

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:

DnsServers List<string>
Domain DnsZoneDomain
LastUpdated string
Name string
TeamId string
TeamSlug string: Required if a default team was not configured in the provider configuration.

DnsServers []string
Domain DnsZoneDomainArgs
LastUpdated string
Name string
TeamId string
TeamSlug string: Required if a default team was not configured in the provider configuration.

dnsServers List<String>
domain DnsZoneDomain
lastUpdated String
name String
teamId String
teamSlug String: Required if a default team was not configured in the provider configuration.

dnsServers string[]
domain DnsZoneDomain
lastUpdated string
name string
teamId string
teamSlug string: Required if a default team was not configured in the provider configuration.

dns_servers Sequence[str]
domain DnsZoneDomainArgs
last_updated str
name str
team_id str
team_slug str: Required if a default team was not configured in the provider configuration.

dnsServers List<String>
domain Property Map
lastUpdated String
name String
teamId String
teamSlug String: Required if a default team was not configured in the provider configuration.

Supporting Types

DnsZoneDomain, DnsZoneDomainArgs

AutoRenew bool
AutoRenewAt string
ExpiresAt string
Id string
Name string
RegisteredAt string
RenewalPrice string

AutoRenew bool
AutoRenewAt string
ExpiresAt string
Id string
Name string
RegisteredAt string
RenewalPrice string

autoRenew Boolean
autoRenewAt String
expiresAt String
id String
name String
registeredAt String
renewalPrice String

autoRenew boolean
autoRenewAt string
expiresAt string
id string
name string
registeredAt string
renewalPrice string

auto_renew bool
auto_renew_at str
expires_at str
id str
name str
registered_at str
renewal_price str

autoRenew Boolean
autoRenewAt String
expiresAt String
id String
name String
registeredAt String
renewalPrice String

Import

Import a DNS zone by its ID

$ pulumi import netlify:index/dnsZone:DnsZone example 6600abcdef1234567890abcd

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

Package Details

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

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify/terraform-provider-netlify

netlify.DnsZone

On this page

On this page

Example Usage

Create DnsZone Resource

Constructor syntax

Parameters

Constructor example

DnsZone Resource Properties

Inputs

Outputs

Look up Existing DnsZone Resource

Supporting Types

DnsZoneDomain, DnsZoneDomainArgs

Import

Package Details

On this page

On this page