Skip to main content

DomainRecords

Resource DomainRecords in pulumi-namecheap.
3 min read

Resource DomainRecords in pulumi-namecheap.

Pulumi type: namecheap:index/domainRecords:DomainRecords.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
domainstringyesPurchased available domain name on your account
domainRecordsIdstringno
emailTypestringnoPossible values: NONE, MXE, MX, FWD, OX, GMAIL
modestringnoPossible values: MERGE (default), OVERWRITE
nameserversstring[]noCustom nameservers to delegate the domain to. Conflicts with emailType and record, which only apply while the domain uses Namecheap DNS.
recordsDomainRecordsRecord (input)[]noOne or more DNS host records for the domain. Conflicts with nameservers, since a domain either uses Namecheap DNS with these records or delegates to custom nameservers.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
domainstringnoPurchased available domain name on your account
domainRecordsIdstringno
emailTypestringnoPossible values: NONE, MXE, MX, FWD, OX, GMAIL
modestringnoPossible values: MERGE (default), OVERWRITE
nameserversstring[]noCustom nameservers to delegate the domain to. Conflicts with emailType and record, which only apply while the domain uses Namecheap DNS.
recordsDomainRecordsRecord (output)[]noOne or more DNS host records for the domain. Conflicts with nameservers, since a domain either uses Namecheap DNS with these records or delegates to custom nameservers.

DomainRecordsRecord (input)#

Input object DomainRecordsRecord. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
addressstringyesPossible values are URL or IP address. The value for this parameter is based on record type
hostnamestringyesSub-domain/hostname to create the record for
mxPrefnumbernoMX preference for host. Applicable for MX records only
ttlnumbernoTime to live for all record types. Possible values: any value between 60 to 60000
typestringyesPossible values: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME

DomainRecordsRecord (output)#

Output object DomainRecordsRecord. Fields below belong to this object.

PropertyTypeAlways presentDescription
addressstringyesPossible values are URL or IP address. The value for this parameter is based on record type
hostnamestringyesSub-domain/hostname to create the record for
mxPrefnumbernoMX preference for host. Applicable for MX records only
ttlnumbernoTime to live for all record types. Possible values: any value between 60 to 60000
typestringyesPossible values: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME