|
| 1 | +--- |
| 2 | +page_title: "Scaleway: scaleway_domain_record" |
| 3 | +description: |- |
| 4 | + Manages Scaleway Domain records. |
| 5 | +--- |
| 6 | + |
| 7 | +# scaleway_domain_record |
| 8 | + |
| 9 | +Creates and manages Scaleway Domain record. |
| 10 | +For more information, see [the documentation](https://www.scaleway.com/en/docs/scaleway-dns/). |
| 11 | + |
| 12 | +## Examples |
| 13 | + |
| 14 | +### Basic |
| 15 | + |
| 16 | +```hcl |
| 17 | +resource "scaleway_domain_record" "www" { |
| 18 | + dns_zone = "domain.tld" |
| 19 | + name = "www" |
| 20 | + type = "A" |
| 21 | + data = "1.2.3.4" |
| 22 | + ttl = 3600 |
| 23 | +} |
| 24 | +
|
| 25 | +resource "scaleway_domain_record" "www2" { |
| 26 | + dns_zone = "domain.tld" |
| 27 | + name = "www" |
| 28 | + type = "A" |
| 29 | + data = "1.2.3.5" |
| 30 | + ttl = 3600 |
| 31 | +} |
| 32 | +
|
| 33 | +resource "scaleway_domain_record" "mx" { |
| 34 | + dns_zone = "domain.tld" |
| 35 | + name = "" |
| 36 | + type = "MX" |
| 37 | + data = "mx.online.net." |
| 38 | + ttl = 3600 |
| 39 | + priority = 10 |
| 40 | +} |
| 41 | +
|
| 42 | +resource "scaleway_domain_record" "mx2" { |
| 43 | + dns_zone = "domain.tld" |
| 44 | + name = "" |
| 45 | + type = "MX" |
| 46 | + data = "mx-cache.online.net." |
| 47 | + ttl = 3600 |
| 48 | + priority = 20 |
| 49 | +} |
| 50 | +``` |
| 51 | + |
| 52 | +### With dynamic records |
| 53 | + |
| 54 | +```hcl |
| 55 | +resource "scaleway_domain_record" "geo_ip" { |
| 56 | + dns_zone = "domain.tld" |
| 57 | + name = "images" |
| 58 | + type = "A" |
| 59 | + data = "1.2.3.4" |
| 60 | + ttl = 3600 |
| 61 | +
|
| 62 | + geo_ip { |
| 63 | + matches { |
| 64 | + continents = ["EU"] |
| 65 | + countries = ["FR"] |
| 66 | + data = "1.2.3.5" |
| 67 | + } |
| 68 | + |
| 69 | + matches { |
| 70 | + continents = ["NA"] |
| 71 | + data = "4.3.2.1" |
| 72 | + } |
| 73 | + } |
| 74 | +} |
| 75 | +
|
| 76 | +resource "scaleway_domain_record" "http_service" { |
| 77 | + dns_zone = "domain.tld" |
| 78 | + name = "app" |
| 79 | + type = "A" |
| 80 | + data = "1.2.3.4" |
| 81 | + ttl = 3600 |
| 82 | +
|
| 83 | + http_service { |
| 84 | + ips = ["1.2.3.5", "1.2.3.6"] |
| 85 | + must_contain = "up" |
| 86 | + url = "http://mywebsite.com/health" |
| 87 | + user_agent = "scw_service_up" |
| 88 | + strategy = "hashed" |
| 89 | + } |
| 90 | +} |
| 91 | +
|
| 92 | +resource "scaleway_domain_record" "view" { |
| 93 | + dns_zone = "domain.tld" |
| 94 | + name = "db" |
| 95 | + type = "A" |
| 96 | + data = "1.2.3.4" |
| 97 | + ttl = 3600 |
| 98 | +
|
| 99 | + view { |
| 100 | + subnet = "100.0.0.0/16" |
| 101 | + data = "1.2.3.5" |
| 102 | + } |
| 103 | +
|
| 104 | + view { |
| 105 | + subnet = "100.1.0.0/16" |
| 106 | + data = "1.2.3.6" |
| 107 | + } |
| 108 | +} |
| 109 | +
|
| 110 | +resource "scaleway_domain_record" "weighted" { |
| 111 | + dns_zone = "domain.tld" |
| 112 | + name = "web" |
| 113 | + type = "A" |
| 114 | + data = "1.2.3.4" |
| 115 | + ttl = 3600 |
| 116 | +
|
| 117 | + weighted { |
| 118 | + ip = "1.2.3.5" |
| 119 | + weight = 1 |
| 120 | + } |
| 121 | +
|
| 122 | + weighted { |
| 123 | + ip = "1.2.3.6" |
| 124 | + weight = 2 |
| 125 | + } |
| 126 | +} |
| 127 | +``` |
| 128 | + |
| 129 | +### Create an instance and add records with the new instance IP |
| 130 | + |
| 131 | +```hcl |
| 132 | +variable "project_id" { |
| 133 | + type = string |
| 134 | + description = "Your project ID." |
| 135 | +} |
| 136 | +
|
| 137 | +variable "dns_zone" { |
| 138 | + type = string |
| 139 | + description = "The DNS Zone used for testing records." |
| 140 | +} |
| 141 | +
|
| 142 | +resource "scaleway_instance_ip" "public_ip" { |
| 143 | + project_id = var.project_id |
| 144 | +} |
| 145 | +
|
| 146 | +resource "scaleway_instance_server" "web" { |
| 147 | + project_id = var.project_id |
| 148 | + type = "DEV1-S" |
| 149 | + image = "ubuntu_focal" |
| 150 | + tags = ["front", "web"] |
| 151 | + ip_id = scaleway_instance_ip.public_ip.id |
| 152 | +
|
| 153 | + root_volume { |
| 154 | + size_in_gb = 20 |
| 155 | + } |
| 156 | +} |
| 157 | +
|
| 158 | +resource "scaleway_domain_record" "web_A" { |
| 159 | + dns_zone = var.dns_zone |
| 160 | + name = "web" |
| 161 | + type = "A" |
| 162 | + data = scaleway_instance_server.web.public_ip |
| 163 | + ttl = 3600 |
| 164 | +} |
| 165 | +
|
| 166 | +resource "scaleway_domain_record" "web_cname" { |
| 167 | + dns_zone = var.dns_zone |
| 168 | + name = "www" |
| 169 | + type = "CNAME" |
| 170 | + data = "web.${var.dns_zone}." |
| 171 | + ttl = 3600 |
| 172 | +} |
| 173 | +
|
| 174 | +resource "scaleway_domain_record" "web_alias" { |
| 175 | + dns_zone = var.dns_zone |
| 176 | + name = "" |
| 177 | + type = "ALIAS" |
| 178 | + data = "web.${var.dns_zone}." |
| 179 | + ttl = 3600 |
| 180 | +} |
| 181 | +``` |
| 182 | + |
| 183 | +## Arguments Reference |
| 184 | + |
| 185 | +The following arguments are supported: |
| 186 | + |
| 187 | +- `dns_zone` - (Required) The DNS Zone of the domain. If the DNS zone doesn't exist, it will be automatically created. |
| 188 | + |
| 189 | +- `keep_empty_zone` - (Optional, default: `false`) When destroying a resource, if only NS records remain and this is set to `false`, the zone will be deleted. Please note, each zone not deleted will [cost you money](https://www.scaleway.com/en/dns/) |
| 190 | + |
| 191 | +- `name` - (Required) The name of the record (can be an empty string for a root record). |
| 192 | + |
| 193 | +- `type` - (Required) The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`). |
| 194 | + |
| 195 | +- `data` - (Required) The content of the record (an IPv4 for an `A`, a string for a `TXT`...). |
| 196 | + |
| 197 | +- `ttl` - (Optional, default: `3600`) Time To Tive of the record in seconds. |
| 198 | + |
| 199 | +- `priority` - (Optional, default: `0`) The priority of the record (mostly used with an `MX` record) |
| 200 | + |
| 201 | +**Dynamic records:** |
| 202 | + |
| 203 | +- `geo_ip` - (Optional) The Geo IP feature provides DNS resolution, based on the user’s geographical location. You can define a default IP that resolves if no Geo IP rule matches, and specify IPs for each geographical zone. [Documentation and usage example](https://www.scaleway.com/en/docs/scaleway-dns/#-Geo-IP-Records) |
| 204 | + - `matches` - (Required) The list of matches. *(Can be more than 1)* |
| 205 | + - `countries` - (Optional) List of countries (eg: `FR` for France, `US` for the United States, `GB` for Great Britain...). [List of all countries code](https://api.scaleway.com/domain-private/v2beta1/countries) |
| 206 | + - `continents` - (Optional) List of continents (eg: `EU` for Europe, `NA` for North America, `AS` for Asia...). [List of all continents code](https://api.scaleway.com/domain-private/v2beta1/continents) |
| 207 | + - `data` (Required) The data of the match result |
| 208 | + |
| 209 | + |
| 210 | +- `http_service` - (Optional) The DNS service checks the provided URL on the configured IPs and resolves the request to one of the IPs by excluding the ones not responding to the given string to check. [Documentation and usage example](https://www.scaleway.com/en/docs/scaleway-dns/#-Healthcheck-records) |
| 211 | + - `ips` - (Required) List of IPs to check |
| 212 | + - `must_contain` - (Required) Text to search |
| 213 | + - `url` - (Required) URL to match the `must_contain` text to validate an IP |
| 214 | + - `user_agent` - (Optional) User-agent used when checking the URL |
| 215 | + - `strategy` - (Required) Strategy to return an IP from the IPs list. Can be `random` or `hashed` |
| 216 | + |
| 217 | + |
| 218 | +- `view` - (Optional) The answer to a DNS request is based on the client’s (resolver) subnet. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/scaleway-dns/#-Views-records) |
| 219 | + - `subnet` - (Required) The subnet of the view |
| 220 | + - `data` - (Required) The data of the view record |
| 221 | + |
| 222 | + |
| 223 | +- `weighted` - (Optional) You provide a list of IPs with their corresponding weights. These weights are used to proportionally direct requests to each IP. Depending on the weight of a record more or fewer requests are answered with its related IP compared to the others in the list. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/scaleway-dns/#-Weight-Records) |
| 224 | + - `ip` - (Required) The weighted IP |
| 225 | + - `weight` - (Required) The weight of the IP as an integer UInt32. |
| 226 | + |
| 227 | +## Multiple records |
| 228 | + |
| 229 | +Some record types can have multiple `data` with the same `name` (eg: `A`, `AAAA`, `MX`, `NS`...). |
| 230 | +You can duplicate a resource `scaleway_domain_record` with the same `name`, the records will be added. |
| 231 | + |
| 232 | +Please note, some record (eg: `CNAME`, Multiple dynamic records of different types...) has to be unique. |
| 233 | + |
| 234 | +## Import |
| 235 | + |
| 236 | +Record can be imported using the `{dns_zone}/{id}`, e.g. |
| 237 | + |
| 238 | +```bash |
| 239 | +$ terraform import scaleway_domain_record.www subdomain.domain.tld/11111111-1111-1111-1111-111111111111 |
| 240 | +``` |
0 commit comments