Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. DNSimple Provider
  4. API Docs
  5. Domain
Viewing docs for DNSimple v5.3.0
published on Wednesday, Aug 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dnsimple

dnsimple.Domain

dnsimple logo
Viewing docs for DNSimple v5.3.0
published on Wednesday, Aug 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dnsimple

    Provides a DNSimple domain resource.

    Warning Destroying a dnsimple.Domain resource deletes the domain from your DNSimple account, and its DNS records are not recoverable. A domain registered through DNSimple stays registered at the registry and remains yours until it expires, but recovering it means adding it back to your account as a zone and then contacting DNSimple support to have the registration relinked. See Recovering a deleted domain.

    Two things are worth knowing before you manage a domain with this resource:

    • Set preventDelete to true to make terraform destroy fail for the resource instead of deleting the domain.
    • If you only want Terraform to stop tracking the domain, remove it from state rather than destroying it. See Removing a domain from Terraform.

    Example Usage

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

const example = new dnsimple.Domain("example", {name: "example.com"});

    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example", name="example.com")

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name = "example.com"
}

    Create Domain Resource

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

    Constructor syntax

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           name: Optional[str] = None,
           prevent_delete: Optional[bool] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

    type: dnsimple:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "dnsimple_domain" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DomainArgs
    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 DomainArgs
    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 DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    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 domainResource = new DNSimple.Domain("domainResource", new()
{
    Name = "string",
    PreventDelete = false,
});

    example, err := dnsimple.NewDomain(ctx, "domainResource", &dnsimple.DomainArgs{
	Name:          pulumi.String("string"),
	PreventDelete: pulumi.Bool(false),
})

    resource "dnsimple_domain" "domainResource" {
  lifecycle {
    create_before_destroy = true
  }
  name           = "string"
  prevent_delete = false
}

    var domainResource = new Domain("domainResource", DomainArgs.builder()
    .name("string")
    .preventDelete(false)
    .build());

    domain_resource = dnsimple.Domain("domainResource",
    name="string",
    prevent_delete=False)

    const domainResource = new dnsimple.Domain("domainResource", {
    name: "string",
    preventDelete: false,
});

    type: dnsimple:Domain
properties:
    name: string
    preventDelete: false

    Domain 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 Domain resource accepts the following input properties:

    Name string
    The domain name to be created.
    PreventDelete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    Name string
    The domain name to be created.
    PreventDelete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    name string
    The domain name to be created.
    prevent_delete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    name String
    The domain name to be created.
    preventDelete Boolean
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    name string
    The domain name to be created.
    preventDelete boolean
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    name str
    The domain name to be created.
    prevent_delete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    name String
    The domain name to be created.
    preventDelete Boolean
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true

    Outputs

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

    AccountId int
    The account ID for the domain.
    AutoRenew bool
    Whether the domain is set to auto-renew.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateWhois bool
    Whether the domain has WhoIs privacy enabled.
    RegistrantId int
    The ID of the registrant (contact) for the domain.
    State string
    The state of the domain.
    Trustee bool
    Whether the domain has a trustee enabled.
    UnicodeName string
    The domain name in Unicode format.
    AccountId int
    The account ID for the domain.
    AutoRenew bool
    Whether the domain is set to auto-renew.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateWhois bool
    Whether the domain has WhoIs privacy enabled.
    RegistrantId int
    The ID of the registrant (contact) for the domain.
    State string
    The state of the domain.
    Trustee bool
    Whether the domain has a trustee enabled.
    UnicodeName string
    The domain name in Unicode format.
    account_id number
    The account ID for the domain.
    auto_renew bool
    Whether the domain is set to auto-renew.
    id string
    The provider-assigned unique ID for this managed resource.
    private_whois bool
    Whether the domain has WhoIs privacy enabled.
    registrant_id number
    The ID of the registrant (contact) for the domain.
    state string
    The state of the domain.
    trustee bool
    Whether the domain has a trustee enabled.
    unicode_name string
    The domain name in Unicode format.
    accountId Integer
    The account ID for the domain.
    autoRenew Boolean
    Whether the domain is set to auto-renew.
    id String
    The provider-assigned unique ID for this managed resource.
    privateWhois Boolean
    Whether the domain has WhoIs privacy enabled.
    registrantId Integer
    The ID of the registrant (contact) for the domain.
    state String
    The state of the domain.
    trustee Boolean
    Whether the domain has a trustee enabled.
    unicodeName String
    The domain name in Unicode format.
    accountId number
    The account ID for the domain.
    autoRenew boolean
    Whether the domain is set to auto-renew.
    id string
    The provider-assigned unique ID for this managed resource.
    privateWhois boolean
    Whether the domain has WhoIs privacy enabled.
    registrantId number
    The ID of the registrant (contact) for the domain.
    state string
    The state of the domain.
    trustee boolean
    Whether the domain has a trustee enabled.
    unicodeName string
    The domain name in Unicode format.
    account_id int
    The account ID for the domain.
    auto_renew bool
    Whether the domain is set to auto-renew.
    id str
    The provider-assigned unique ID for this managed resource.
    private_whois bool
    Whether the domain has WhoIs privacy enabled.
    registrant_id int
    The ID of the registrant (contact) for the domain.
    state str
    The state of the domain.
    trustee bool
    Whether the domain has a trustee enabled.
    unicode_name str
    The domain name in Unicode format.
    accountId Number
    The account ID for the domain.
    autoRenew Boolean
    Whether the domain is set to auto-renew.
    id String
    The provider-assigned unique ID for this managed resource.
    privateWhois Boolean
    Whether the domain has WhoIs privacy enabled.
    registrantId Number
    The ID of the registrant (contact) for the domain.
    state String
    The state of the domain.
    trustee Boolean
    Whether the domain has a trustee enabled.
    unicodeName String
    The domain name in Unicode format.

    Look up Existing Domain Resource

    Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[int] = None,
        auto_renew: Optional[bool] = None,
        name: Optional[str] = None,
        prevent_delete: Optional[bool] = None,
        private_whois: Optional[bool] = None,
        registrant_id: Optional[int] = None,
        state: Optional[str] = None,
        trustee: Optional[bool] = None,
        unicode_name: Optional[str] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    resources:  _:    type: dnsimple:Domain    get:      id: ${id}
    import {
  to = dnsimple_domain.example
  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:
    AccountId int
    The account ID for the domain.
    AutoRenew bool
    Whether the domain is set to auto-renew.
    Name string
    The domain name to be created.
    PreventDelete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_privatewhois_csharp">

    PrivateWhois bool

    Whether the domain has WhoIs privacy enabled.
    RegistrantId int
    The ID of the registrant (contact) for the domain.
    State string
    The state of the domain.
    Trustee bool
    Whether the domain has a trustee enabled.
    UnicodeName string
    The domain name in Unicode format.

    AccountId int
    The account ID for the domain.
    AutoRenew bool
    Whether the domain is set to auto-renew.
    Name string
    The domain name to be created.
    PreventDelete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_privatewhois_go">

    PrivateWhois bool

    Whether the domain has WhoIs privacy enabled.
    RegistrantId int
    The ID of the registrant (contact) for the domain.
    State string
    The state of the domain.
    Trustee bool
    Whether the domain has a trustee enabled.
    UnicodeName string
    The domain name in Unicode format.

    account_id number
    The account ID for the domain.
    auto_renew bool
    Whether the domain is set to auto-renew.
    name string
    The domain name to be created.
    prevent_delete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_private_whois_hcl">

    private_whois bool

    Whether the domain has WhoIs privacy enabled.
    registrant_id number
    The ID of the registrant (contact) for the domain.
    state string
    The state of the domain.
    trustee bool
    Whether the domain has a trustee enabled.
    unicode_name string
    The domain name in Unicode format.

    accountId Integer
    The account ID for the domain.
    autoRenew Boolean
    Whether the domain is set to auto-renew.
    name String
    The domain name to be created.
    preventDelete Boolean
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_privatewhois_java">

    privateWhois Boolean

    Whether the domain has WhoIs privacy enabled.
    registrantId Integer
    The ID of the registrant (contact) for the domain.
    state String
    The state of the domain.
    trustee Boolean
    Whether the domain has a trustee enabled.
    unicodeName String
    The domain name in Unicode format.

    accountId number
    The account ID for the domain.
    autoRenew boolean
    Whether the domain is set to auto-renew.
    name string
    The domain name to be created.
    preventDelete boolean
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_privatewhois_nodejs">

    privateWhois boolean

    Whether the domain has WhoIs privacy enabled.
    registrantId number
    The ID of the registrant (contact) for the domain.
    state string
    The state of the domain.
    trustee boolean
    Whether the domain has a trustee enabled.
    unicodeName string
    The domain name in Unicode format.

    account_id int
    The account ID for the domain.
    auto_renew bool
    Whether the domain is set to auto-renew.
    name str
    The domain name to be created.
    prevent_delete bool
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_private_whois_python">

    private_whois bool

    Whether the domain has WhoIs privacy enabled.
    registrant_id int
    The ID of the registrant (contact) for the domain.
    state str
    The state of the domain.
    trustee bool
    Whether the domain has a trustee enabled.
    unicode_name str
    The domain name in Unicode format.

    accountId Number
    The account ID for the domain.
    autoRenew Boolean
    Whether the domain is set to auto-renew.
    name String
    The domain name to be created.
    preventDelete Boolean
    Optional flag to guard against accidental registration deletion of the domain (default false). Set it to true and terraform destroy will fail for this resource. Because changing name requires replacement, and replacement destroys the existing domain, renaming also fails while it is enabled — set it back to false and apply first.

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

    const example = new dnsimple.Domain("example", {
name: "example.com",
preventDelete: true,
});


    import pulumi
import pulumi_dnsimple as dnsimple

example = dnsimple.Domain("example",
    name="example.com",
    prevent_delete=True)

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

return await Deployment.RunAsync(() => 
{
    var example = new DNSimple.Domain("example", new()
    {
        Name = "example.com",
        PreventDelete = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dnsimple.NewDomain(ctx, "example", &dnsimple.DomainArgs{
			Name:          pulumi.String("example.com"),
			PreventDelete: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    dnsimple = {
      source = "pulumi/dnsimple"
    }
  }
}

resource "dnsimple_domain" "example" {
  name           = "example.com"
  prevent_delete = true
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.Domain;
import com.pulumi.dnsimple.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
            .name("example.com")
            .preventDelete(true)
            .build());

    }
}

    resources:
  example:
    type: dnsimple:Domain
    properties:
      name: example.com
      preventDelete: true
    title="Optional"> <span id="state_privatewhois_yaml">

    privateWhois Boolean

    Whether the domain has WhoIs privacy enabled.
    registrantId Number
    The ID of the registrant (contact) for the domain.
    state String
    The state of the domain.
    trustee Boolean
    Whether the domain has a trustee enabled.
    unicodeName String
    The domain name in Unicode format.

    Import

    DNSimple domains can be imported using the domain name.

    $ pulumi import dnsimple:index/domain:Domain example example.com

    The domain name can be found within the DNSimple Domains API. Check out Authentication in API Overview for available options.

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

    Package Details

    Repository
    DNSimple pulumi/pulumi-dnsimple
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dnsimple Terraform Provider.
    dnsimple logo
    Viewing docs for DNSimple v5.3.0
    published on Wednesday, Aug 5, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-dnsimple

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial