Skip to content

Commit

Permalink
Merge pull request #4876 from cloudflare/update-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz authored Jan 10, 2025
2 parents 28589da + f2485f5 commit b386b1f
Show file tree
Hide file tree
Showing 27 changed files with 237 additions and 1,282 deletions.
12 changes: 6 additions & 6 deletions docs/data-sources/address_map.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ description: |-

```terraform
data "cloudflare_address_map" "example_address_map" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
address_map_id = "023e105f4ecef8ad9ca31a8372d0c353"
account_id = "258def64c72dae45f3e4c8516e2111f2"
address_map_id = "055817b111884e0227e1be16a0be6ee0"
}
```

Expand All @@ -23,8 +23,8 @@ data "cloudflare_address_map" "example_address_map" {

### Optional

- `account_id` (String) Identifier
- `address_map_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.
- `address_map_id` (String) Identifier of an Address Map.
- `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))

### Read-Only
Expand All @@ -35,7 +35,7 @@ data "cloudflare_address_map" "example_address_map" {
- `default_sni` (String) If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
- `description` (String) An optional description field which may be used to describe the types of IPs or zones on the map.
- `enabled` (Boolean) Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
- `id` (String) Identifier
- `id` (String) Identifier of an Address Map.
- `ips` (Attributes List) The set of IPs on the Address Map. (see [below for nested schema](#nestedatt--ips))
- `memberships` (Attributes List) Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership. (see [below for nested schema](#nestedatt--memberships))
- `modified_at` (String)
Expand All @@ -45,7 +45,7 @@ data "cloudflare_address_map" "example_address_map" {

Required:

- `account_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.


<a id="nestedatt--ips"></a>
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/address_maps.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-

```terraform
data "cloudflare_address_maps" "example_address_maps" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
account_id = "258def64c72dae45f3e4c8516e2111f2"
}
```

Expand All @@ -22,7 +22,7 @@ data "cloudflare_address_maps" "example_address_maps" {

### Required

- `account_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.

### Optional

Expand All @@ -43,7 +43,7 @@ Read-Only:
- `default_sni` (String) If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.
- `description` (String) An optional description field which may be used to describe the types of IPs or zones on the map.
- `enabled` (Boolean) Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
- `id` (String) Identifier
- `id` (String) Identifier of an Address Map.
- `modified_at` (String)


2 changes: 2 additions & 0 deletions docs/data-sources/authenticated_origin_pulls_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ data "cloudflare_authenticated_origin_pulls_certificate" "example_authenticated_
### Read-Only

- `certificate` (String) The zone's leaf certificate.
- `enabled` (Boolean) Indicates whether zone-level authenticated origin pulls is enabled.
- `expires_on` (String) When the certificate from the authority expires.
- `id` (String) Identifier
- `issuer` (String) The certificate authority that issued the certificate.
- `private_key` (String) The zone's private key.
- `signature` (String) The type of hash used for the certificate.
- `status` (String) Status of the certificate activation.
- `uploaded_on` (String) This is the time the certificate was uploaded.
Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/authenticated_origin_pulls_certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ data "cloudflare_authenticated_origin_pulls_certificates" "example_authenticated
Read-Only:

- `certificate` (String) The zone's leaf certificate.
- `enabled` (Boolean) Indicates whether zone-level authenticated origin pulls is enabled.
- `expires_on` (String) When the certificate from the authority expires.
- `id` (String) Identifier
- `issuer` (String) The certificate authority that issued the certificate.
- `private_key` (String) The zone's private key.
- `signature` (String) The type of hash used for the certificate.
- `status` (String) Status of the certificate activation.
- `uploaded_on` (String) This is the time the certificate was uploaded.
Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/byo_ip_prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ description: |-

```terraform
data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
prefix_id = "023e105f4ecef8ad9ca31a8372d0c353"
account_id = "258def64c72dae45f3e4c8516e2111f2"
prefix_id = "2af39739cc4e3b5910c918468bb89828"
}
```

Expand All @@ -23,9 +23,9 @@ data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" {

### Optional

- `account_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.
- `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))
- `prefix_id` (String) Identifier
- `prefix_id` (String) Identifier of an IP Prefix.

### Read-Only

Expand All @@ -36,7 +36,7 @@ data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" {
- `cidr` (String) IP Prefix in Classless Inter-Domain Routing format.
- `created_at` (String)
- `description` (String) Description of the prefix.
- `id` (String) Identifier
- `id` (String) Identifier of an IP Prefix.
- `loa_document_id` (String) Identifier for the uploaded LOA document.
- `modified_at` (String)
- `on_demand_enabled` (Boolean) Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
Expand All @@ -47,6 +47,6 @@ data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" {

Required:

- `account_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.


8 changes: 4 additions & 4 deletions docs/data-sources/byo_ip_prefixes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-

```terraform
data "cloudflare_byo_ip_prefixes" "example_byo_ip_prefixes" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
account_id = "258def64c72dae45f3e4c8516e2111f2"
}
```

Expand All @@ -22,7 +22,7 @@ data "cloudflare_byo_ip_prefixes" "example_byo_ip_prefixes" {

### Required

- `account_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.

### Optional

Expand All @@ -37,15 +37,15 @@ data "cloudflare_byo_ip_prefixes" "example_byo_ip_prefixes" {

Read-Only:

- `account_id` (String) Identifier
- `account_id` (String) Identifier of a Cloudflare account.
- `advertised` (Boolean) Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
- `advertised_modified_at` (String) Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
- `approved` (String) Approval state of the prefix (P = pending, V = active).
- `asn` (Number) Autonomous System Number (ASN) the prefix will be advertised under.
- `cidr` (String) IP Prefix in Classless Inter-Domain Routing format.
- `created_at` (String)
- `description` (String) Description of the prefix.
- `id` (String) Identifier
- `id` (String) Identifier of an IP Prefix.
- `loa_document_id` (String) Identifier for the uploaded LOA document.
- `modified_at` (String)
- `on_demand_enabled` (Boolean) Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/custom_hostname.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ data "cloudflare_custom_hostname" "example_custom_hostname" {
- `id` (String) Identifier
- `ownership_verification` (Attributes) This is a record which can be placed to activate a hostname. (see [below for nested schema](#nestedatt--ownership_verification))
- `ownership_verification_http` (Attributes) This presents the token to be served by the given http url to activate a hostname. (see [below for nested schema](#nestedatt--ownership_verification_http))
- `ssl` (Attributes) SSL properties for the custom hostname. (see [below for nested schema](#nestedatt--ssl))
- `ssl` (Attributes) (see [below for nested schema](#nestedatt--ssl))
- `status` (String) Status of the hostname's activation.
- `verification_errors` (List of String) These are errors that were encountered while trying to activate a hostname.

Expand Down Expand Up @@ -92,7 +92,7 @@ Read-Only:
- `issuer` (String) The issuer on a custom uploaded certificate.
- `method` (String) Domain control validation (DCV) method used for this hostname.
- `serial_number` (String) The serial number on a custom uploaded certificate.
- `settings` (Attributes) SSL specific settings. (see [below for nested schema](#nestedatt--ssl--settings))
- `settings` (Attributes) (see [below for nested schema](#nestedatt--ssl--settings))
- `signature` (String) The signature on a custom uploaded certificate.
- `status` (String) Status of the hostname's SSL certificates.
- `type` (String) Level of validation to be used for this hostname. Domain validation (dv) must be used.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/custom_hostnames.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Read-Only:
- `id` (String) Identifier
- `ownership_verification` (Attributes) This is a record which can be placed to activate a hostname. (see [below for nested schema](#nestedatt--result--ownership_verification))
- `ownership_verification_http` (Attributes) This presents the token to be served by the given http url to activate a hostname. (see [below for nested schema](#nestedatt--result--ownership_verification_http))
- `ssl` (Attributes) SSL properties for the custom hostname. (see [below for nested schema](#nestedatt--result--ssl))
- `ssl` (Attributes) (see [below for nested schema](#nestedatt--result--ssl))
- `status` (String) Status of the hostname's activation.
- `verification_errors` (List of String) These are errors that were encountered while trying to activate a hostname.

Expand Down Expand Up @@ -93,7 +93,7 @@ Read-Only:
- `issuer` (String) The issuer on a custom uploaded certificate.
- `method` (String) Domain control validation (DCV) method used for this hostname.
- `serial_number` (String) The serial number on a custom uploaded certificate.
- `settings` (Attributes) SSL specific settings. (see [below for nested schema](#nestedatt--result--ssl--settings))
- `settings` (Attributes) (see [below for nested schema](#nestedatt--result--ssl--settings))
- `signature` (String) The signature on a custom uploaded certificate.
- `status` (String) Status of the hostname's SSL certificates.
- `type` (String) Level of validation to be used for this hostname. Domain validation (dv) must be used.
Expand Down
9 changes: 8 additions & 1 deletion docs/data-sources/dns_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,20 @@ data "cloudflare_dns_record" "example_dns_record" {
### Read-Only

- `comment` (String) Comments or notes about the DNS record. This field has no effect on DNS responses.
- `comment_modified_on` (String) When the record comment was last modified. Omitted if there is no comment.
- `content` (String) A valid IPv4 address.
- `created_on` (String) When the record was created.
- `data` (Attributes) Components of a CAA record. (see [below for nested schema](#nestedatt--data))
- `id` (String) Identifier
- `meta` (String) Extra Cloudflare-specific information about the record.
- `modified_on` (String) When the record was last modified.
- `name` (String) DNS record name (or @ for the zone apex) in Punycode.
- `priority` (Number) Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
- `proxiable` (Boolean) Whether the record can be proxied by Cloudflare or not.
- `proxied` (Boolean) Whether the record is receiving the performance and security benefits of Cloudflare.
- `settings` (Attributes) Settings for the DNS record. (see [below for nested schema](#nestedatt--settings))
- `tags` (List of String) Custom tags for the DNS record. This field has no effect on DNS responses.
- `tags_modified_on` (String) When the record tags were last modified. Omitted if there are no tags.
- `ttl` (Number) Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
- `type` (String) Record type.

Expand Down Expand Up @@ -158,7 +165,7 @@ Read-Only:

Read-Only:

- `flatten_cname` (Boolean) If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting has no effect on proxied records, which are always flattened.
- `flatten_cname` (Boolean) If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
- `ipv4_only` (Boolean) When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
- `ipv6_only` (Boolean) When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

Expand Down
9 changes: 8 additions & 1 deletion docs/data-sources/dns_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,20 @@ Optional:
Read-Only:

- `comment` (String) Comments or notes about the DNS record. This field has no effect on DNS responses.
- `comment_modified_on` (String) When the record comment was last modified. Omitted if there is no comment.
- `content` (String) A valid IPv4 address.
- `created_on` (String) When the record was created.
- `data` (Attributes) Components of a CAA record. (see [below for nested schema](#nestedatt--result--data))
- `id` (String) Identifier
- `meta` (String) Extra Cloudflare-specific information about the record.
- `modified_on` (String) When the record was last modified.
- `name` (String) DNS record name (or @ for the zone apex) in Punycode.
- `priority` (Number) Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
- `proxiable` (Boolean) Whether the record can be proxied by Cloudflare or not.
- `proxied` (Boolean) Whether the record is receiving the performance and security benefits of Cloudflare.
- `settings` (Attributes) Settings for the DNS record. (see [below for nested schema](#nestedatt--result--settings))
- `tags` (List of String) Custom tags for the DNS record. This field has no effect on DNS responses.
- `tags_modified_on` (String) When the record tags were last modified. Omitted if there are no tags.
- `ttl` (Number) Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
- `type` (String) Record type.

Expand Down Expand Up @@ -185,7 +192,7 @@ Read-Only:

Read-Only:

- `flatten_cname` (Boolean) If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting has no effect on proxied records, which are always flattened.
- `flatten_cname` (Boolean) If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
- `ipv4_only` (Boolean) When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
- `ipv6_only` (Boolean) When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

Expand Down
38 changes: 30 additions & 8 deletions docs/data-sources/list_item.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ data "cloudflare_list_item" "example_list_item" {

### Read-Only

- `include_subdomains` (Boolean)
- `preserve_path_suffix` (Boolean)
- `preserve_query_string` (Boolean)
- `source_url` (String)
- `status_code` (Number)
- `subpath_matching` (Boolean)
- `target_url` (String)
- `url_hostname` (String)
- `asn` (Number) A non-negative 32 bit integer
- `comment` (String) An informative summary of the list item.
- `created_on` (String) The RFC 3339 timestamp of when the item was created.
- `hostname` (Attributes) Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-). (see [below for nested schema](#nestedatt--hostname))
- `id` (String) The unique ID of the list.
- `ip` (String) An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
- `modified_on` (String) The RFC 3339 timestamp of when the item was last modified.
- `redirect` (Attributes) The definition of the redirect. (see [below for nested schema](#nestedatt--redirect))

<a id="nestedatt--filter"></a>
### Nested Schema for `filter`
Expand All @@ -53,3 +53,25 @@ Optional:
- `search` (String) A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.


<a id="nestedatt--hostname"></a>
### Nested Schema for `hostname`

Read-Only:

- `url_hostname` (String)


<a id="nestedatt--redirect"></a>
### Nested Schema for `redirect`

Read-Only:

- `include_subdomains` (Boolean)
- `preserve_path_suffix` (Boolean)
- `preserve_query_string` (Boolean)
- `source_url` (String)
- `status_code` (Number)
- `subpath_matching` (Boolean)
- `target_url` (String)


23 changes: 22 additions & 1 deletion docs/data-sources/list_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,34 @@ data "cloudflare_list_items" "example_list_items" {

Read-Only:

- `asn` (Number) A non-negative 32 bit integer
- `comment` (String) An informative summary of the list item.
- `created_on` (String) The RFC 3339 timestamp of when the item was created.
- `hostname` (Attributes) Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-). (see [below for nested schema](#nestedatt--result--hostname))
- `id` (String) The unique ID of the list.
- `ip` (String) An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
- `modified_on` (String) The RFC 3339 timestamp of when the item was last modified.
- `redirect` (Attributes) The definition of the redirect. (see [below for nested schema](#nestedatt--result--redirect))

<a id="nestedatt--result--hostname"></a>
### Nested Schema for `result.hostname`

Read-Only:

- `url_hostname` (String)


<a id="nestedatt--result--redirect"></a>
### Nested Schema for `result.redirect`

Read-Only:

- `include_subdomains` (Boolean)
- `preserve_path_suffix` (Boolean)
- `preserve_query_string` (Boolean)
- `source_url` (String)
- `status_code` (Number)
- `subpath_matching` (Boolean)
- `target_url` (String)
- `url_hostname` (String)


Loading

0 comments on commit b386b1f

Please sign in to comment.