dnsimple.Domain
Explore with Pulumi AI
Provides a DNSimple domain resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as dnsimple from "@pulumi/dnsimple";
// Create a domain
const foobar = new dnsimple.Domain("foobar", {name: dnsimple.domain});
import pulumi
import pulumi_dnsimple as dnsimple
# Create a domain
foobar = dnsimple.Domain("foobar", name=dnsimple["domain"])
package main
import (
	"github.com/pulumi/pulumi-dnsimple/sdk/v4/go/dnsimple"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a domain
		_, err := dnsimple.NewDomain(ctx, "foobar", &dnsimple.DomainArgs{
			Name: pulumi.Any(dnsimple.Domain),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DNSimple = Pulumi.DNSimple;
return await Deployment.RunAsync(() => 
{
    // Create a domain
    var foobar = new DNSimple.Domain("foobar", new()
    {
        Name = dnsimple.Domain,
    });
});
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.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) {
        // Create a domain
        var foobar = new Domain("foobar", DomainArgs.builder()
            .name(dnsimple.domain())
            .build());
    }
}
resources:
  # Create a domain
  foobar:
    type: dnsimple:Domain
    properties:
      name: ${dnsimple.domain}
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)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.
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",
});
example, err := dnsimple.NewDomain(ctx, "domainResource", &dnsimple.DomainArgs{
	Name: pulumi.String("string"),
})
var domainResource = new Domain("domainResource", DomainArgs.builder()
    .name("string")
    .build());
domain_resource = dnsimple.Domain("domainResource", name="string")
const domainResource = new dnsimple.Domain("domainResource", {name: "string"});
type: dnsimple:Domain
properties:
    name: string
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 createdAttributes Reference
- Name string
- The domain name to be createdAttributes Reference
- name String
- The domain name to be createdAttributes Reference
- name string
- The domain name to be createdAttributes Reference
- name str
- The domain name to be createdAttributes Reference
- name String
- The domain name to be createdAttributes Reference
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.
- 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.
- UnicodeName 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.
- 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.
- 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.
- 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.
- 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,
        private_whois: Optional[bool] = None,
        registrant_id: Optional[int] = None,
        state: Optional[str] = None,
        unicode_name: Optional[str] = None) -> Domainfunc 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}- 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.
- 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 createdAttributes Reference
- 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.
- 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 createdAttributes Reference
- 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.
- UnicodeName 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 createdAttributes Reference
- 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.
- 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 createdAttributes Reference
- 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.
- 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 createdAttributes Reference
- 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.
- 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 createdAttributes Reference
- 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.
- unicodeName String
- The domain name in Unicode format.
Import
DNSimple domains can be imported using their numeric record ID.
bash
$ pulumi import dnsimple:index/domain:Domain resource_name 5678
The record ID can be found within DNSimple Domains API. Check out Authentication in API Overview for available options.
bash
curl -u ‘EMAIL:PASSWORD’ https://api.dnsimple.com/v2/1234/domains?name_like=example.com | jq
{
“data”: [
{
  "id": 5678,
  "account_id": 1234,
  "registrant_id": null,
  "name": "example.com",
  "unicode_name": "example.com",
  "state": "hosted",
  "auto_renew": false,
  "private_whois": false,
  "expires_on": null,
  "expires_at": null,
  "created_at": "2021-10-01T00:00:00Z",
  "updated_at": "2021-10-01T00:00:00Z"
}
],
“pagination”: {
"current_page": 1,
"per_page": 30,
"total_entries": 1,
"total_pages": 1
}
}
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 dnsimpleTerraform Provider.