digitalocean_domains
Generated on 22 Apr 2025
from Terraform version
v2.51.0
Get information on domains for use in other resources, with the ability to filter and sort the results. If no filters are specified, all domains will be returned.
This data source is useful if the domains in question are not managed by Terraform or you need to utilize any of the domains’ data.
Note: You can use the digitalocean_domain
data source to obtain metadata
about a single domain if you already know the name
.
Example Usage
Use the filter
block with a key
string and values
list to filter domains. (This example
also uses the regular expression match_by
mode in order to match domains by suffix.)
data "digitalocean_domains" "examples" {
filter {
key = "name"
values = ["example\\.com$"]
match_by = "re"
}
}
Argument Reference
-
filter
- (Optional) Filter the results. Thefilter
block is documented below. -
sort
- (Optional) Sort the results. Thesort
block is documented below.
filter
supports the following arguments:
-
key
- (Required) Filter the domains by this key. This may be one ofname
,urn
, andttl
. -
values
- (Required) A list of values to match against thekey
field. Only retrieves domains where thekey
field takes on one or more of the values provided here. -
match_by
- (Optional) One ofexact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field. -
all
- (Optional) Set totrue
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.
sort
supports the following arguments:
-
key
- (Required) Sort the domains by this key. This may be one ofname
,urn
, andttl
. -
direction
- (Required) The sort direction. This may be eitherasc
ordesc
.
Attributes Reference
-
domains
- A list of domains satisfying anyfilter
andsort
criteria. Each domain has the following attributes:name
- (Required) The name of the domain.ttl
- The TTL of the domain.urn
- The uniform resource name of the domain