gandi logo
Gandi v0.0.14, Dec 17 22

gandi.domains.Domain

Create Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: 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)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = 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.

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.

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

The Domain resource accepts the following input properties:

Owner DomainOwnerArgs
Admin DomainAdminArgs
Autorenew bool

Should the domain autorenew

Billing DomainBillingArgs
Name string

The FQDN of the domain

Nameservers List<string>

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

Tags List<string>

A list of tags attached to the domain

Tech DomainTechArgs
Owner DomainOwnerArgs
Admin DomainAdminArgs
Autorenew bool

Should the domain autorenew

Billing DomainBillingArgs
Name string

The FQDN of the domain

Nameservers []string

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

Tags []string

A list of tags attached to the domain

Tech DomainTechArgs
owner DomainOwnerArgs
admin DomainAdminArgs
autorenew Boolean

Should the domain autorenew

billing DomainBillingArgs
name String

The FQDN of the domain

nameservers List<String>

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

tags List<String>

A list of tags attached to the domain

tech DomainTechArgs
owner DomainOwnerArgs
admin DomainAdminArgs
autorenew boolean

Should the domain autorenew

billing DomainBillingArgs
name string

The FQDN of the domain

nameservers string[]

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

tags string[]

A list of tags attached to the domain

tech DomainTechArgs
owner DomainOwnerArgs
admin DomainAdminArgs
autorenew bool

Should the domain autorenew

billing DomainBillingArgs
name str

The FQDN of the domain

nameservers Sequence[str]

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

tags Sequence[str]

A list of tags attached to the domain

tech DomainTechArgs
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

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

tags 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.
The following state arguments are supported:
Admin DomainAdminArgs
Autorenew bool

Should the domain autorenew

Billing DomainBillingArgs
Name string

The FQDN of the domain

Nameservers List<string>

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

Owner DomainOwnerArgs
Tags List<string>

A list of tags attached to the domain

Tech DomainTechArgs
Admin DomainAdminArgs
Autorenew bool

Should the domain autorenew

Billing DomainBillingArgs
Name string

The FQDN of the domain

Nameservers []string

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

Owner DomainOwnerArgs
Tags []string

A list of tags attached to the domain

Tech DomainTechArgs
admin DomainAdminArgs
autorenew Boolean

Should the domain autorenew

billing DomainBillingArgs
name String

The FQDN of the domain

nameservers List<String>

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

owner DomainOwnerArgs
tags List<String>

A list of tags attached to the domain

tech DomainTechArgs
admin DomainAdminArgs
autorenew boolean

Should the domain autorenew

billing DomainBillingArgs
name string

The FQDN of the domain

nameservers string[]

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

owner DomainOwnerArgs
tags string[]

A list of tags attached to the domain

tech DomainTechArgs
admin DomainAdminArgs
autorenew bool

Should the domain autorenew

billing DomainBillingArgs
name str

The FQDN of the domain

nameservers Sequence[str]

A list of nameservers for the domain

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

owner DomainOwnerArgs
tags Sequence[str]

A list of tags attached to the domain

tech DomainTechArgs
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

Deprecated:

This nameservers attribute will be removed on next major release: the nameservers resource has to be used instead. See https://github.com/go-gandi/terraform-provider-gandi/issues/88 for details.

owner Property Map
tags List<String>

A list of tags attached to the domain

tech Property Map

Supporting Types

DomainAdmin

City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters Dictionary<string, string>
MailObfuscated bool
Organisation string
State string
City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters map[string]string
MailObfuscated bool
Organisation string
State string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String,String>
mailObfuscated Boolean
organisation String
state String
city string
country string
email string
familyName string
givenName string
phone string
streetAddr string
type string
zip string
dataObfuscated boolean
extraParameters {[key: string]: string}
mailObfuscated boolean
organisation string
state string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String>
mailObfuscated Boolean
organisation String
state String

DomainBilling

City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters Dictionary<string, string>
MailObfuscated bool
Organisation string
State string
City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters map[string]string
MailObfuscated bool
Organisation string
State string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String,String>
mailObfuscated Boolean
organisation String
state String
city string
country string
email string
familyName string
givenName string
phone string
streetAddr string
type string
zip string
dataObfuscated boolean
extraParameters {[key: string]: string}
mailObfuscated boolean
organisation string
state string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String>
mailObfuscated Boolean
organisation String
state String

DomainOwner

City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters Dictionary<string, string>
MailObfuscated bool
Organisation string
State string
City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters map[string]string
MailObfuscated bool
Organisation string
State string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String,String>
mailObfuscated Boolean
organisation String
state String
city string
country string
email string
familyName string
givenName string
phone string
streetAddr string
type string
zip string
dataObfuscated boolean
extraParameters {[key: string]: string}
mailObfuscated boolean
organisation string
state string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String>
mailObfuscated Boolean
organisation String
state String

DomainTech

City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters Dictionary<string, string>
MailObfuscated bool
Organisation string
State string
City string
Country string
Email string
FamilyName string
GivenName string
Phone string
StreetAddr string
Type string
Zip string
DataObfuscated bool
ExtraParameters map[string]string
MailObfuscated bool
Organisation string
State string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String,String>
mailObfuscated Boolean
organisation String
state String
city string
country string
email string
familyName string
givenName string
phone string
streetAddr string
type string
zip string
dataObfuscated boolean
extraParameters {[key: string]: string}
mailObfuscated boolean
organisation string
state string
city String
country String
email String
familyName String
givenName String
phone String
streetAddr String
type String
zip String
dataObfuscated Boolean
extraParameters Map<String>
mailObfuscated 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.