Skip to content

Commit 49bbfc7

Browse files
committed
chore: update docs and examples
1 parent 5ae607d commit 49bbfc7

File tree

82 files changed

+1203
-750
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+1203
-750
lines changed

docs/data-sources/account_dns_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Read-Only:
6868

6969
- `expire` (Number) Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
7070
- `min_ttl` (Number) The time to live (TTL) for negative caching of records within the zone.
71-
- `mname` (String) The primary nameserver, which may be used for outbound zone transfers.
71+
- `mname` (String) The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.
7272
- `refresh` (Number) Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
7373
- `retry` (Number) Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
7474
- `rname` (String) The email address of the zone administrator, with the first label representing the local part of the email address.

docs/data-sources/bot_management.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ data "cloudflare_bot_management" "example_bot_management" {
3030
Available values: "block", "disabled", "only_on_ad_pages".
3131
- `auto_update_model` (Boolean) Automatically update to the newest bot detection models created by Cloudflare as they are released. [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes)
3232
- `bm_cookie_enabled` (Boolean) Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true
33+
- `cf_robots_variant` (String) Specifies the Robots Access Control License variant to use.
34+
Available values: "off", "policy_only".
3335
- `crawler_protection` (String) Enable rule to punish AI Scrapers and Crawlers via a link maze.
3436
Available values: "enabled", "disabled".
3537
- `enable_js` (Boolean) Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/).

docs/data-sources/byo_ip_prefix.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" {
3131

3232
### Read-Only
3333

34-
- `advertised` (Boolean) Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
35-
- `advertised_modified_at` (String) Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
34+
- `advertised` (Boolean, Deprecated) Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
35+
- `advertised_modified_at` (String, Deprecated) Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
3636
- `approved` (String) Approval state of the prefix (P = pending, V = active).
3737
- `asn` (Number) Autonomous System Number (ASN) the prefix will be advertised under.
3838
- `cidr` (String) IP Prefix in Classless Inter-Domain Routing format.
@@ -41,7 +41,7 @@ data "cloudflare_byo_ip_prefix" "example_byo_ip_prefix" {
4141
- `id` (String) Identifier of an IP Prefix.
4242
- `loa_document_id` (String) Identifier for the uploaded LOA document.
4343
- `modified_at` (String)
44-
- `on_demand_enabled` (Boolean) Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
45-
- `on_demand_locked` (Boolean) Whether advertisement status of the prefix is locked, meaning it cannot be changed.
44+
- `on_demand_enabled` (Boolean, Deprecated) Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
45+
- `on_demand_locked` (Boolean, Deprecated) Whether advertisement status of the prefix is locked, meaning it cannot be changed.
4646

4747

docs/data-sources/byo_ip_prefixes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ data "cloudflare_byo_ip_prefixes" "example_byo_ip_prefixes" {
3838
Read-Only:
3939

4040
- `account_id` (String) Identifier of a Cloudflare account.
41-
- `advertised` (Boolean) Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
42-
- `advertised_modified_at` (String) Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
41+
- `advertised` (Boolean, Deprecated) Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
42+
- `advertised_modified_at` (String, Deprecated) Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
4343
- `approved` (String) Approval state of the prefix (P = pending, V = active).
4444
- `asn` (Number) Autonomous System Number (ASN) the prefix will be advertised under.
4545
- `cidr` (String) IP Prefix in Classless Inter-Domain Routing format.
@@ -48,7 +48,7 @@ Read-Only:
4848
- `id` (String) Identifier of an IP Prefix.
4949
- `loa_document_id` (String) Identifier for the uploaded LOA document.
5050
- `modified_at` (String)
51-
- `on_demand_enabled` (Boolean) Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
52-
- `on_demand_locked` (Boolean) Whether advertisement status of the prefix is locked, meaning it cannot be changed.
51+
- `on_demand_enabled` (Boolean, Deprecated) Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
52+
- `on_demand_locked` (Boolean, Deprecated) Whether advertisement status of the prefix is locked, meaning it cannot be changed.
5353

5454

docs/data-sources/dns_firewall.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,35 @@ data "cloudflare_dns_firewall" "example_dns_firewall" {
3636
- `dns_firewall_ips` (Set of String)
3737
- `ecs_fallback` (Boolean) Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
3838
- `id` (String) Identifier.
39-
- `maximum_cache_ttl` (Number) Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Higher TTLs will be decreased to the maximum defined here for caching purposes.
40-
- `minimum_cache_ttl` (Number) Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Lower TTLs will be increased to the minimum defined here for caching purposes.
39+
- `maximum_cache_ttl` (Number) By default, Cloudflare attempts to cache responses for as long as
40+
indicated by the TTL received from upstream nameservers. This setting
41+
sets an upper bound on this duration. For caching purposes, higher TTLs
42+
will be decreased to the maximum value defined by this setting.
43+
44+
This setting does not affect the TTL value in the DNS response
45+
Cloudflare returns to clients. Cloudflare will always forward the TTL
46+
value received from upstream nameservers.
47+
- `minimum_cache_ttl` (Number) By default, Cloudflare attempts to cache responses for as long as
48+
indicated by the TTL received from upstream nameservers. This setting
49+
sets a lower bound on this duration. For caching purposes, lower TTLs
50+
will be increased to the minimum value defined by this setting.
51+
52+
This setting does not affect the TTL value in the DNS response
53+
Cloudflare returns to clients. Cloudflare will always forward the TTL
54+
value received from upstream nameservers.
55+
56+
Note that, even with this setting, there is no guarantee that a
57+
response will be cached for at least the specified duration. Cached
58+
responses may be removed earlier for capacity or other operational
59+
reasons.
4160
- `modified_on` (String) Last modification of DNS Firewall cluster
4261
- `name` (String) DNS Firewall cluster name
43-
- `negative_cache_ttl` (Number) Negative DNS cache TTL This setting controls how long DNS Firewall should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
62+
- `negative_cache_ttl` (Number) This setting controls how long DNS Firewall should cache negative
63+
responses (e.g., NXDOMAIN) from the upstream servers.
64+
65+
This setting does not affect the TTL value in the DNS response
66+
Cloudflare returns to clients. Cloudflare will always forward the TTL
67+
value received from upstream nameservers.
4468
- `ratelimit` (Number) Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster)
4569
- `retries` (Number) Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt)
4670
- `upstream_ips` (Set of String)

docs/data-sources/dns_firewalls.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,35 @@ Read-Only:
4242
- `dns_firewall_ips` (Set of String)
4343
- `ecs_fallback` (Boolean) Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
4444
- `id` (String) Identifier.
45-
- `maximum_cache_ttl` (Number) Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Higher TTLs will be decreased to the maximum defined here for caching purposes.
46-
- `minimum_cache_ttl` (Number) Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Lower TTLs will be increased to the minimum defined here for caching purposes.
45+
- `maximum_cache_ttl` (Number) By default, Cloudflare attempts to cache responses for as long as
46+
indicated by the TTL received from upstream nameservers. This setting
47+
sets an upper bound on this duration. For caching purposes, higher TTLs
48+
will be decreased to the maximum value defined by this setting.
49+
50+
This setting does not affect the TTL value in the DNS response
51+
Cloudflare returns to clients. Cloudflare will always forward the TTL
52+
value received from upstream nameservers.
53+
- `minimum_cache_ttl` (Number) By default, Cloudflare attempts to cache responses for as long as
54+
indicated by the TTL received from upstream nameservers. This setting
55+
sets a lower bound on this duration. For caching purposes, lower TTLs
56+
will be increased to the minimum value defined by this setting.
57+
58+
This setting does not affect the TTL value in the DNS response
59+
Cloudflare returns to clients. Cloudflare will always forward the TTL
60+
value received from upstream nameservers.
61+
62+
Note that, even with this setting, there is no guarantee that a
63+
response will be cached for at least the specified duration. Cached
64+
responses may be removed earlier for capacity or other operational
65+
reasons.
4766
- `modified_on` (String) Last modification of DNS Firewall cluster
4867
- `name` (String) DNS Firewall cluster name
49-
- `negative_cache_ttl` (Number) Negative DNS cache TTL This setting controls how long DNS Firewall should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
68+
- `negative_cache_ttl` (Number) This setting controls how long DNS Firewall should cache negative
69+
responses (e.g., NXDOMAIN) from the upstream servers.
70+
71+
This setting does not affect the TTL value in the DNS response
72+
Cloudflare returns to clients. Cloudflare will always forward the TTL
73+
value received from upstream nameservers.
5074
- `ratelimit` (Number) Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster)
5175
- `retries` (Number) Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt)
5276
- `upstream_ips` (Set of String)

docs/data-sources/load_balancer_pool.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ data "cloudflare_load_balancer_pool" "example_load_balancer_pool" {
4444
- `minimum_origins` (Number) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
4545
- `modified_on` (String)
4646
- `monitor` (String) The ID of the Monitor to use for checking the health of origins within this pool.
47+
- `monitor_group` (String) The ID of the Monitor Group to use for checking the health of origins within this pool.
4748
- `name` (String) A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
4849
- `networks` (List of String) List of networks where Load Balancer or Pool is enabled.
4950
- `notification_email` (String) This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

docs/data-sources/load_balancer_pools.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Read-Only:
5151
- `minimum_origins` (Number) The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
5252
- `modified_on` (String)
5353
- `monitor` (String) The ID of the Monitor to use for checking the health of origins within this pool.
54+
- `monitor_group` (String) The ID of the Monitor Group to use for checking the health of origins within this pool.
5455
- `name` (String) A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
5556
- `networks` (List of String) List of networks where Load Balancer or Pool is enabled.
5657
- `notification_email` (String) This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

docs/data-sources/magic_wan_gre_tunnel.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ data "cloudflare_magic_wan_gre_tunnel" "example_magic_wan_gre_tunnel" {
3535

3636
Read-Only:
3737

38+
- `automatic_return_routing` (Boolean) True if automatic stateful return routing should be enabled for a tunnel, false otherwise.
3839
- `bgp` (Attributes) (see [below for nested schema](#nestedatt--gre_tunnel--bgp))
3940
- `bgp_status` (Attributes) (see [below for nested schema](#nestedatt--gre_tunnel--bgp_status))
4041
- `cloudflare_gre_endpoint` (String) The IP address assigned to the Cloudflare side of the GRE tunnel.

docs/data-sources/magic_wan_ipsec_tunnel.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@ data "cloudflare_magic_wan_ipsec_tunnel" "example_magic_wan_ipsec_tunnel" {
3636
Read-Only:
3737

3838
- `allow_null_cipher` (Boolean) When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).
39+
- `automatic_return_routing` (Boolean) True if automatic stateful return routing should be enabled for a tunnel, false otherwise.
3940
- `bgp` (Attributes) (see [below for nested schema](#nestedatt--ipsec_tunnel--bgp))
4041
- `bgp_status` (Attributes) (see [below for nested schema](#nestedatt--ipsec_tunnel--bgp_status))
4142
- `cloudflare_endpoint` (String) The IP address assigned to the Cloudflare side of the IPsec tunnel.
4243
- `created_on` (String) The date and time the tunnel was created.
44+
- `custom_remote_identities` (Attributes) (see [below for nested schema](#nestedatt--ipsec_tunnel--custom_remote_identities))
4345
- `customer_endpoint` (String) The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.
4446
- `description` (String) An optional description forthe IPsec tunnel.
4547
- `health_check` (Attributes) (see [below for nested schema](#nestedatt--ipsec_tunnel--health_check))
@@ -91,6 +93,21 @@ Read-Only:
9193
- `updated_at` (String)
9294

9395

96+
<a id="nestedatt--ipsec_tunnel--custom_remote_identities"></a>
97+
### Nested Schema for `ipsec_tunnel.custom_remote_identities`
98+
99+
Read-Only:
100+
101+
- `fqdn_id` (String) A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The
102+
generated IKE IDs can still be used even if this custom value is specified.
103+
104+
Must be of the form `<custom label>.<account ID>.custom.ipsec.cloudflare.com`.
105+
106+
This custom ID does not need to be unique. Two IPsec tunnels may have the same custom
107+
fqdn_id. However, if another IPsec tunnel has the same value then the two tunnels
108+
cannot have the same cloudflare_endpoint.
109+
110+
94111
<a id="nestedatt--ipsec_tunnel--health_check"></a>
95112
### Nested Schema for `ipsec_tunnel.health_check`
96113

0 commit comments

Comments
 (0)