# DomainHostRecord

> Resource DomainHostRecord in pulumi-namecheap.

<!-- Generated from the pulumi-namecheap SDK. -->

Resource DomainHostRecord in pulumi-namecheap.

Pulumi type: `namecheap:index/domainHostRecord:DomainHostRecord`.

`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.

```ts
import * as namecheap from "pulumi-namecheap"

const resource = new namecheap.DomainHostRecord("domainHostRecord", {
  address: "<address>",
  domain: "example.com",
  hostname: "www",
  type: "<type>",
})
```

## Arguments

| Property             | Type     | Required | Description                                                                                                                                                                                                                                                                                                                                                                       |
| -------------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `address`            | `string` | yes      | The record's value, whose meaning depends on `type`: an IP address for A/AAAA, a hostname for CNAME/MX/NS, arbitrary text for TXT, a URL for URL/URL301/FRAME. Changing this does not force a new resource: the existing record is edited, in one write that swaps the value, so the name never stops resolving. The resource id is re-rendered, since the address is part of it. |
| `domain`             | `string` | yes      | The registered root domain the record belongs to (e.g. `example.com`). Must be a root domain on the account, not a subdomain. Changing this forces a new resource.                                                                                                                                                                                                                |
| `domainHostRecordId` | `string` | no       |                                                                                                                                                                                                                                                                                                                                                                                   |
| `hostname`           | `string` | yes      | The sub-domain the record answers for, or `@` for the domain itself (e.g. `www`). Changing this forces a new resource, because the host is part of the record's identity.                                                                                                                                                                                                         |
| `mxPref`             | `number` | no       | The MX preference, lower being preferred, between 0 and 255. Applies to MX records only — Namecheap stores a fixed 10 for every other type, so the value is ignored there rather than fought over. For MX records it is part of what identifies the record, so a primary and a backup mail server can name the same host.                                                         |
| `ttl`                | `number` | no       | Time to live in seconds, between 60 and 60000. Changing this edits the existing record rather than forcing a new resource.                                                                                                                                                                                                                                                        |
| `type`               | `string` | yes      | The record type: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME. Changing this forces a new resource. MX and MXE records additionally require the domain's email routing to be set accordingly — see the resource documentation.                                                                                                                                |

## Outputs

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

| Property             | Type     | Computed | Description                                                                                                                                                                                                                                                                                                                                                                       |
| -------------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `address`            | `string` | no       | The record's value, whose meaning depends on `type`: an IP address for A/AAAA, a hostname for CNAME/MX/NS, arbitrary text for TXT, a URL for URL/URL301/FRAME. Changing this does not force a new resource: the existing record is edited, in one write that swaps the value, so the name never stops resolving. The resource id is re-rendered, since the address is part of it. |
| `domain`             | `string` | no       | The registered root domain the record belongs to (e.g. `example.com`). Must be a root domain on the account, not a subdomain. Changing this forces a new resource.                                                                                                                                                                                                                |
| `domainHostRecordId` | `string` | no       |                                                                                                                                                                                                                                                                                                                                                                                   |
| `hostname`           | `string` | no       | The sub-domain the record answers for, or `@` for the domain itself (e.g. `www`). Changing this forces a new resource, because the host is part of the record's identity.                                                                                                                                                                                                         |
| `mxPref`             | `number` | no       | The MX preference, lower being preferred, between 0 and 255. Applies to MX records only — Namecheap stores a fixed 10 for every other type, so the value is ignored there rather than fought over. For MX records it is part of what identifies the record, so a primary and a backup mail server can name the same host.                                                         |
| `ttl`                | `number` | no       | Time to live in seconds, between 60 and 60000. Changing this edits the existing record rather than forcing a new resource.                                                                                                                                                                                                                                                        |
| `type`               | `string` | no       | The record type: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME. Changing this forces a new resource. MX and MXE records additionally require the domain's email routing to be set accordingly — see the resource documentation.                                                                                                                                |