gandi.domains.Domain
Explore with Pulumi AI
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,
owner: Optional[DomainOwnerArgs] = None,
admin: Optional[DomainAdminArgs] = None,
autorenew: Optional[bool] = None,
billing: Optional[DomainBillingArgs] = None,
name: Optional[str] = None,
nameservers: Optional[Sequence[str]] = None,
tags: Optional[Sequence[str]] = None,
tech: Optional[DomainTechArgs] = 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: gandi:domains: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 Gandi.Domains.Domain("domainResource", new()
{
Owner = new Gandi.Domains.Inputs.DomainOwnerArgs
{
GivenName = "string",
Phone = "string",
Zip = "string",
Email = "string",
Type = "string",
FamilyName = "string",
Country = "string",
City = "string",
StreetAddr = "string",
ExtraParameters =
{
{ "string", "string" },
},
Organisation = "string",
State = "string",
MailObfuscated = false,
DataObfuscated = false,
},
Admin = new Gandi.Domains.Inputs.DomainAdminArgs
{
GivenName = "string",
Phone = "string",
Zip = "string",
Email = "string",
Type = "string",
FamilyName = "string",
Country = "string",
City = "string",
StreetAddr = "string",
ExtraParameters =
{
{ "string", "string" },
},
Organisation = "string",
State = "string",
MailObfuscated = false,
DataObfuscated = false,
},
Autorenew = false,
Billing = new Gandi.Domains.Inputs.DomainBillingArgs
{
GivenName = "string",
Phone = "string",
Zip = "string",
Email = "string",
Type = "string",
FamilyName = "string",
Country = "string",
City = "string",
StreetAddr = "string",
ExtraParameters =
{
{ "string", "string" },
},
Organisation = "string",
State = "string",
MailObfuscated = false,
DataObfuscated = false,
},
Name = "string",
Tags = new[]
{
"string",
},
Tech = new Gandi.Domains.Inputs.DomainTechArgs
{
GivenName = "string",
Phone = "string",
Zip = "string",
Email = "string",
Type = "string",
FamilyName = "string",
Country = "string",
City = "string",
StreetAddr = "string",
ExtraParameters =
{
{ "string", "string" },
},
Organisation = "string",
State = "string",
MailObfuscated = false,
DataObfuscated = false,
},
});
example, err := domains.NewDomain(ctx, "domainResource", &domains.DomainArgs{
Owner: &domains.DomainOwnerArgs{
GivenName: pulumi.String("string"),
Phone: pulumi.String("string"),
Zip: pulumi.String("string"),
Email: pulumi.String("string"),
Type: pulumi.String("string"),
FamilyName: pulumi.String("string"),
Country: pulumi.String("string"),
City: pulumi.String("string"),
StreetAddr: pulumi.String("string"),
ExtraParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Organisation: pulumi.String("string"),
State: pulumi.String("string"),
MailObfuscated: pulumi.Bool(false),
DataObfuscated: pulumi.Bool(false),
},
Admin: &domains.DomainAdminArgs{
GivenName: pulumi.String("string"),
Phone: pulumi.String("string"),
Zip: pulumi.String("string"),
Email: pulumi.String("string"),
Type: pulumi.String("string"),
FamilyName: pulumi.String("string"),
Country: pulumi.String("string"),
City: pulumi.String("string"),
StreetAddr: pulumi.String("string"),
ExtraParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Organisation: pulumi.String("string"),
State: pulumi.String("string"),
MailObfuscated: pulumi.Bool(false),
DataObfuscated: pulumi.Bool(false),
},
Autorenew: pulumi.Bool(false),
Billing: &domains.DomainBillingArgs{
GivenName: pulumi.String("string"),
Phone: pulumi.String("string"),
Zip: pulumi.String("string"),
Email: pulumi.String("string"),
Type: pulumi.String("string"),
FamilyName: pulumi.String("string"),
Country: pulumi.String("string"),
City: pulumi.String("string"),
StreetAddr: pulumi.String("string"),
ExtraParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Organisation: pulumi.String("string"),
State: pulumi.String("string"),
MailObfuscated: pulumi.Bool(false),
DataObfuscated: pulumi.Bool(false),
},
Name: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Tech: &domains.DomainTechArgs{
GivenName: pulumi.String("string"),
Phone: pulumi.String("string"),
Zip: pulumi.String("string"),
Email: pulumi.String("string"),
Type: pulumi.String("string"),
FamilyName: pulumi.String("string"),
Country: pulumi.String("string"),
City: pulumi.String("string"),
StreetAddr: pulumi.String("string"),
ExtraParameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
Organisation: pulumi.String("string"),
State: pulumi.String("string"),
MailObfuscated: pulumi.Bool(false),
DataObfuscated: pulumi.Bool(false),
},
})
var domainResource = new Domain("domainResource", DomainArgs.builder()
.owner(DomainOwnerArgs.builder()
.givenName("string")
.phone("string")
.zip("string")
.email("string")
.type("string")
.familyName("string")
.country("string")
.city("string")
.streetAddr("string")
.extraParameters(Map.of("string", "string"))
.organisation("string")
.state("string")
.mailObfuscated(false)
.dataObfuscated(false)
.build())
.admin(DomainAdminArgs.builder()
.givenName("string")
.phone("string")
.zip("string")
.email("string")
.type("string")
.familyName("string")
.country("string")
.city("string")
.streetAddr("string")
.extraParameters(Map.of("string", "string"))
.organisation("string")
.state("string")
.mailObfuscated(false)
.dataObfuscated(false)
.build())
.autorenew(false)
.billing(DomainBillingArgs.builder()
.givenName("string")
.phone("string")
.zip("string")
.email("string")
.type("string")
.familyName("string")
.country("string")
.city("string")
.streetAddr("string")
.extraParameters(Map.of("string", "string"))
.organisation("string")
.state("string")
.mailObfuscated(false)
.dataObfuscated(false)
.build())
.name("string")
.tags("string")
.tech(DomainTechArgs.builder()
.givenName("string")
.phone("string")
.zip("string")
.email("string")
.type("string")
.familyName("string")
.country("string")
.city("string")
.streetAddr("string")
.extraParameters(Map.of("string", "string"))
.organisation("string")
.state("string")
.mailObfuscated(false)
.dataObfuscated(false)
.build())
.build());
domain_resource = gandi.domains.Domain("domainResource",
owner={
"given_name": "string",
"phone": "string",
"zip": "string",
"email": "string",
"type": "string",
"family_name": "string",
"country": "string",
"city": "string",
"street_addr": "string",
"extra_parameters": {
"string": "string",
},
"organisation": "string",
"state": "string",
"mail_obfuscated": False,
"data_obfuscated": False,
},
admin={
"given_name": "string",
"phone": "string",
"zip": "string",
"email": "string",
"type": "string",
"family_name": "string",
"country": "string",
"city": "string",
"street_addr": "string",
"extra_parameters": {
"string": "string",
},
"organisation": "string",
"state": "string",
"mail_obfuscated": False,
"data_obfuscated": False,
},
autorenew=False,
billing={
"given_name": "string",
"phone": "string",
"zip": "string",
"email": "string",
"type": "string",
"family_name": "string",
"country": "string",
"city": "string",
"street_addr": "string",
"extra_parameters": {
"string": "string",
},
"organisation": "string",
"state": "string",
"mail_obfuscated": False,
"data_obfuscated": False,
},
name="string",
tags=["string"],
tech={
"given_name": "string",
"phone": "string",
"zip": "string",
"email": "string",
"type": "string",
"family_name": "string",
"country": "string",
"city": "string",
"street_addr": "string",
"extra_parameters": {
"string": "string",
},
"organisation": "string",
"state": "string",
"mail_obfuscated": False,
"data_obfuscated": False,
})
const domainResource = new gandi.domains.Domain("domainResource", {
owner: {
givenName: "string",
phone: "string",
zip: "string",
email: "string",
type: "string",
familyName: "string",
country: "string",
city: "string",
streetAddr: "string",
extraParameters: {
string: "string",
},
organisation: "string",
state: "string",
mailObfuscated: false,
dataObfuscated: false,
},
admin: {
givenName: "string",
phone: "string",
zip: "string",
email: "string",
type: "string",
familyName: "string",
country: "string",
city: "string",
streetAddr: "string",
extraParameters: {
string: "string",
},
organisation: "string",
state: "string",
mailObfuscated: false,
dataObfuscated: false,
},
autorenew: false,
billing: {
givenName: "string",
phone: "string",
zip: "string",
email: "string",
type: "string",
familyName: "string",
country: "string",
city: "string",
streetAddr: "string",
extraParameters: {
string: "string",
},
organisation: "string",
state: "string",
mailObfuscated: false,
dataObfuscated: false,
},
name: "string",
tags: ["string"],
tech: {
givenName: "string",
phone: "string",
zip: "string",
email: "string",
type: "string",
familyName: "string",
country: "string",
city: "string",
streetAddr: "string",
extraParameters: {
string: "string",
},
organisation: "string",
state: "string",
mailObfuscated: false,
dataObfuscated: false,
},
});
type: gandi:domains:Domain
properties:
admin:
city: string
country: string
dataObfuscated: false
email: string
extraParameters:
string: string
familyName: string
givenName: string
mailObfuscated: false
organisation: string
phone: string
state: string
streetAddr: string
type: string
zip: string
autorenew: false
billing:
city: string
country: string
dataObfuscated: false
email: string
extraParameters:
string: string
familyName: string
givenName: string
mailObfuscated: false
organisation: string
phone: string
state: string
streetAddr: string
type: string
zip: string
name: string
owner:
city: string
country: string
dataObfuscated: false
email: string
extraParameters:
string: string
familyName: string
givenName: string
mailObfuscated: false
organisation: string
phone: string
state: string
streetAddr: string
type: string
zip: string
tags:
- string
tech:
city: string
country: string
dataObfuscated: false
email: string
extraParameters:
string: string
familyName: string
givenName: string
mailObfuscated: false
organisation: string
phone: string
state: string
streetAddr: string
type: string
zip: 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:
- Owner
Domain
Owner - Admin
Domain
Admin - Autorenew bool
- Should the domain autorenew
- Billing
Domain
Billing - Name string
- The FQDN of the domain
- Nameservers List<string>
- A list of nameservers for the domain
- List<string>
- A list of tags attached to the domain
- Tech
Domain
Tech
- Owner
Domain
Owner Args - Admin
Domain
Admin Args - Autorenew bool
- Should the domain autorenew
- Billing
Domain
Billing Args - Name string
- The FQDN of the domain
- Nameservers []string
- A list of nameservers for the domain
- []string
- A list of tags attached to the domain
- Tech
Domain
Tech Args
- owner
Domain
Owner - admin
Domain
Admin - autorenew Boolean
- Should the domain autorenew
- billing
Domain
Billing - name String
- The FQDN of the domain
- nameservers List<String>
- A list of nameservers for the domain
- List<String>
- A list of tags attached to the domain
- tech
Domain
Tech
- owner
Domain
Owner - admin
Domain
Admin - autorenew boolean
- Should the domain autorenew
- billing
Domain
Billing - name string
- The FQDN of the domain
- nameservers string[]
- A list of nameservers for the domain
- string[]
- A list of tags attached to the domain
- tech
Domain
Tech
- owner
Domain
Owner Args - admin
Domain
Admin Args - autorenew bool
- Should the domain autorenew
- billing
Domain
Billing Args - name str
- The FQDN of the domain
- nameservers Sequence[str]
- A list of nameservers for the domain
- Sequence[str]
- A list of tags attached to the domain
- tech
Domain
Tech Args
- owner Property Map
- admin Property Map
- autorenew Boolean
- Should the domain autorenew
- billing Property Map
- name String
- The FQDN of the domain
- nameservers List<String>
- A list of nameservers for the domain
- List<String>
- A list of tags attached to the domain
- tech Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
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,
admin: Optional[DomainAdminArgs] = None,
autorenew: Optional[bool] = None,
billing: Optional[DomainBillingArgs] = None,
name: Optional[str] = None,
nameservers: Optional[Sequence[str]] = None,
owner: Optional[DomainOwnerArgs] = None,
tags: Optional[Sequence[str]] = None,
tech: Optional[DomainTechArgs] = 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)
Resource lookup is not supported in YAML
- 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.
- Admin
Domain
Admin - Autorenew bool
- Should the domain autorenew
- Billing
Domain
Billing - Name string
- The FQDN of the domain
- Nameservers List<string>
- A list of nameservers for the domain
- Owner
Domain
Owner - List<string>
- A list of tags attached to the domain
- Tech
Domain
Tech
- Admin
Domain
Admin Args - Autorenew bool
- Should the domain autorenew
- Billing
Domain
Billing Args - Name string
- The FQDN of the domain
- Nameservers []string
- A list of nameservers for the domain
- Owner
Domain
Owner Args - []string
- A list of tags attached to the domain
- Tech
Domain
Tech Args
- admin
Domain
Admin - autorenew Boolean
- Should the domain autorenew
- billing
Domain
Billing - name String
- The FQDN of the domain
- nameservers List<String>
- A list of nameservers for the domain
- owner
Domain
Owner - List<String>
- A list of tags attached to the domain
- tech
Domain
Tech
- admin
Domain
Admin - autorenew boolean
- Should the domain autorenew
- billing
Domain
Billing - name string
- The FQDN of the domain
- nameservers string[]
- A list of nameservers for the domain
- owner
Domain
Owner - string[]
- A list of tags attached to the domain
- tech
Domain
Tech
- admin
Domain
Admin Args - autorenew bool
- Should the domain autorenew
- billing
Domain
Billing Args - name str
- The FQDN of the domain
- nameservers Sequence[str]
- A list of nameservers for the domain
- owner
Domain
Owner Args - Sequence[str]
- A list of tags attached to the domain
- tech
Domain
Tech Args
- admin Property Map
- autorenew Boolean
- Should the domain autorenew
- billing Property Map
- name String
- The FQDN of the domain
- nameservers List<String>
- A list of nameservers for the domain
- owner Property Map
- List<String>
- A list of tags attached to the domain
- tech Property Map
Supporting Types
DomainAdmin, DomainAdminArgs
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters Dictionary<string, string> - Mail
Obfuscated bool - Organisation string
- State string
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters map[string]string - Mail
Obfuscated bool - Organisation string
- State string
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String,String> - mail
Obfuscated Boolean - organisation String
- state String
- city string
- country string
- email string
- family
Name string - given
Name string - phone string
- street
Addr string - type string
- zip string
- data
Obfuscated boolean - extra
Parameters {[key: string]: string} - mail
Obfuscated boolean - organisation string
- state string
- city str
- country str
- email str
- family_
name str - given_
name str - phone str
- street_
addr str - type str
- zip str
- data_
obfuscated bool - extra_
parameters Mapping[str, str] - mail_
obfuscated bool - organisation str
- state str
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String> - mail
Obfuscated Boolean - organisation String
- state String
DomainBilling, DomainBillingArgs
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters Dictionary<string, string> - Mail
Obfuscated bool - Organisation string
- State string
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters map[string]string - Mail
Obfuscated bool - Organisation string
- State string
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String,String> - mail
Obfuscated Boolean - organisation String
- state String
- city string
- country string
- email string
- family
Name string - given
Name string - phone string
- street
Addr string - type string
- zip string
- data
Obfuscated boolean - extra
Parameters {[key: string]: string} - mail
Obfuscated boolean - organisation string
- state string
- city str
- country str
- email str
- family_
name str - given_
name str - phone str
- street_
addr str - type str
- zip str
- data_
obfuscated bool - extra_
parameters Mapping[str, str] - mail_
obfuscated bool - organisation str
- state str
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String> - mail
Obfuscated Boolean - organisation String
- state String
DomainOwner, DomainOwnerArgs
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters Dictionary<string, string> - Mail
Obfuscated bool - Organisation string
- State string
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters map[string]string - Mail
Obfuscated bool - Organisation string
- State string
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String,String> - mail
Obfuscated Boolean - organisation String
- state String
- city string
- country string
- email string
- family
Name string - given
Name string - phone string
- street
Addr string - type string
- zip string
- data
Obfuscated boolean - extra
Parameters {[key: string]: string} - mail
Obfuscated boolean - organisation string
- state string
- city str
- country str
- email str
- family_
name str - given_
name str - phone str
- street_
addr str - type str
- zip str
- data_
obfuscated bool - extra_
parameters Mapping[str, str] - mail_
obfuscated bool - organisation str
- state str
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String> - mail
Obfuscated Boolean - organisation String
- state String
DomainTech, DomainTechArgs
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters Dictionary<string, string> - Mail
Obfuscated bool - Organisation string
- State string
- City string
- Country string
- Email string
- Family
Name string - Given
Name string - Phone string
- Street
Addr string - Type string
- Zip string
- Data
Obfuscated bool - Extra
Parameters map[string]string - Mail
Obfuscated bool - Organisation string
- State string
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String,String> - mail
Obfuscated Boolean - organisation String
- state String
- city string
- country string
- email string
- family
Name string - given
Name string - phone string
- street
Addr string - type string
- zip string
- data
Obfuscated boolean - extra
Parameters {[key: string]: string} - mail
Obfuscated boolean - organisation string
- state string
- city str
- country str
- email str
- family_
name str - given_
name str - phone str
- street_
addr str - type str
- zip str
- data_
obfuscated bool - extra_
parameters Mapping[str, str] - mail_
obfuscated bool - organisation str
- state str
- city String
- country String
- email String
- family
Name String - given
Name String - phone String
- street
Addr String - type String
- zip String
- data
Obfuscated Boolean - extra
Parameters Map<String> - mail
Obfuscated Boolean - organisation String
- state String
Package Details
- Repository
- gandi pulumiverse/pulumi-gandi
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
gandi
Terraform Provider.