Skip to content

Commit fd286e4

Browse files
musa-cfstainless-app[bot]
authored andcommitted
Generated docs for v5.7.1 release
1 parent e6eba90 commit fd286e4

File tree

59 files changed

+1177
-493
lines changed

Some content is hidden

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

59 files changed

+1177
-493
lines changed

docs/data-sources/account_api_token_permission_groups.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ description: |-
1414
```terraform
1515
data "cloudflare_account_api_token_permission_groups" "example_account_api_token_permission_groups" {
1616
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
17+
name = "Account%20Settings%20Write"
18+
scope = "com.cloudflare.api.account.zone"
1719
}
1820
```
1921

@@ -24,10 +26,11 @@ data "cloudflare_account_api_token_permission_groups" "example_account_api_token
2426

2527
- `account_id` (String) Account identifier tag.
2628

27-
### Read-Only
29+
### Optional
2830

29-
- `id` (String) Public ID.
30-
- `name` (String) Permission Group Name
31-
- `scopes` (List of String) Resources to which the Permission Group is scoped
31+
- `name` (String) Filter by the name of the permission group.
32+
The value must be URL-encoded.
33+
- `scope` (String) Filter by the scope of the permission group.
34+
The value must be URL-encoded.
3235

3336

docs/data-sources/account_api_token_permission_groups_list.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ description: |-
1414
```terraform
1515
data "cloudflare_account_api_token_permission_groups_list" "example_account_api_token_permission_groups_list" {
1616
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
17+
name = "Account%20Settings%20Write"
18+
scope = "com.cloudflare.api.account.zone"
1719
}
1820
```
1921

@@ -27,6 +29,10 @@ data "cloudflare_account_api_token_permission_groups_list" "example_account_api_
2729
### Optional
2830

2931
- `max_items` (Number) Max items to fetch, default: 1000
32+
- `name` (String) Filter by the name of the permission group.
33+
The value must be URL-encoded.
34+
- `scope` (String) Filter by the scope of the permission group.
35+
The value must be URL-encoded.
3036

3137
### Read-Only
3238

docs/data-sources/api_token_permission_groups_list.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ description: |-
1313

1414
```terraform
1515
data "cloudflare_api_token_permission_groups_list" "example_api_token_permission_groups_list" {
16-
16+
name = "Account%20Settings%20Write"
17+
scope = "com.cloudflare.api.account.zone"
1718
}
1819
```
1920

@@ -23,6 +24,10 @@ data "cloudflare_api_token_permission_groups_list" "example_api_token_permission
2324
### Optional
2425

2526
- `max_items` (Number) Max items to fetch, default: 1000
27+
- `name` (String) Filter by the name of the permission group.
28+
The value must be URL-encoded.
29+
- `scope` (String) Filter by the scope of the permission group.
30+
The value must be URL-encoded.
2631

2732
### Read-Only
2833

docs/data-sources/bot_management.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ data "cloudflare_bot_management" "example_bot_management" {
2626

2727
### Read-Only
2828

29-
- `ai_bots_protection` (String) Enable rule to block AI Scrapers and Crawlers.
30-
Available values: "block", "disabled".
29+
- `ai_bots_protection` (String) Enable rule to block AI Scrapers and Crawlers. Please note the value `only_on_ad_pages` is currently not available for Enterprise customers.
30+
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
- `crawler_protection` (String) Enable rule to punish AI Scrapers and Crawlers via a link maze.
3333
Available values: "enabled", "disabled".

docs/data-sources/hyperdrive_config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ data "cloudflare_hyperdrive_config" "example_hyperdrive_config" {
3838
- `mtls` (Attributes) (see [below for nested schema](#nestedatt--mtls))
3939
- `name` (String)
4040
- `origin` (Attributes) (see [below for nested schema](#nestedatt--origin))
41+
- `origin_connection_limit` (Number) The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database.
4142

4243
<a id="nestedatt--caching"></a>
4344
### Nested Schema for `caching`

docs/data-sources/hyperdrive_configs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Read-Only:
4444
- `mtls` (Attributes) (see [below for nested schema](#nestedatt--result--mtls))
4545
- `name` (String)
4646
- `origin` (Attributes) (see [below for nested schema](#nestedatt--result--origin))
47+
- `origin_connection_limit` (Number) The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database.
4748

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

docs/data-sources/list.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ data "cloudflare_list" "example_list" {
2424
### Required
2525

2626
- `account_id` (String) Defines an identifier.
27+
28+
### Optional
29+
2730
- `list_id` (String) The unique ID of the list.
2831

2932
### Read-Only

docs/data-sources/list_item.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ data "cloudflare_list_item" "example_list_item" {
3535
- `created_on` (String) The RFC 3339 timestamp of when the item was created.
3636
- `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))
3737
- `id` (String) The unique ID of the list.
38-
- `ip` (String) An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
38+
- `ip` (String) An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
3939
- `modified_on` (String) The RFC 3339 timestamp of when the item was last modified.
4040
- `redirect` (Attributes) The definition of the redirect. (see [below for nested schema](#nestedatt--redirect))
4141

docs/data-sources/list_items.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
page_title: "cloudflare_list_items Data Source - Cloudflare"
3+
subcategory: ""
4+
description: |-
5+
6+
---
7+
8+
# cloudflare_list_items (Data Source)
9+
10+
11+
12+
## Example Usage
13+
14+
```terraform
15+
data "cloudflare_list_items" "example_list_items" {
16+
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
17+
list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e"
18+
search = "1.1.1."
19+
}
20+
```
21+
22+
<!-- schema generated by tfplugindocs -->
23+
## Schema
24+
25+
### Required
26+
27+
- `account_id` (String) Defines an identifier.
28+
- `list_id` (String) The unique ID of the list.
29+
30+
### Optional
31+
32+
- `max_items` (Number) Max items to fetch, default: 1000
33+
- `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.
34+
35+
### Read-Only
36+
37+
- `result` (Attributes List) The items returned by the data source (see [below for nested schema](#nestedatt--result))
38+
39+
<a id="nestedatt--result"></a>
40+
### Nested Schema for `result`
41+
42+
Read-Only:
43+
44+
- `asn` (Number) Defines a non-negative 32 bit integer.
45+
- `comment` (String) Defines an informative summary of the list item.
46+
- `created_on` (String) The RFC 3339 timestamp of when the item was created.
47+
- `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))
48+
- `id` (String) The unique ID of the list.
49+
- `ip` (String) An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
50+
- `modified_on` (String) The RFC 3339 timestamp of when the item was last modified.
51+
- `redirect` (Attributes) The definition of the redirect. (see [below for nested schema](#nestedatt--result--redirect))
52+
53+
<a id="nestedatt--result--hostname"></a>
54+
### Nested Schema for `result.hostname`
55+
56+
Read-Only:
57+
58+
- `url_hostname` (String)
59+
60+
61+
<a id="nestedatt--result--redirect"></a>
62+
### Nested Schema for `result.redirect`
63+
64+
Read-Only:
65+
66+
- `include_subdomains` (Boolean)
67+
- `preserve_path_suffix` (Boolean)
68+
- `preserve_query_string` (Boolean)
69+
- `source_url` (String)
70+
- `status_code` (Number) Available values: 301, 302, 307, 308.
71+
- `subpath_matching` (Boolean)
72+
- `target_url` (String)
73+
74+

docs/data-sources/lists.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
page_title: "cloudflare_lists Data Source - Cloudflare"
3+
subcategory: ""
4+
description: |-
5+
6+
---
7+
8+
# cloudflare_lists (Data Source)
9+
10+
11+
12+
## Example Usage
13+
14+
```terraform
15+
data "cloudflare_lists" "example_lists" {
16+
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
17+
}
18+
```
19+
20+
<!-- schema generated by tfplugindocs -->
21+
## Schema
22+
23+
### Required
24+
25+
- `account_id` (String) Defines an identifier.
26+
27+
### Optional
28+
29+
- `max_items` (Number) Max items to fetch, default: 1000
30+
31+
### Read-Only
32+
33+
- `result` (Attributes List) The items returned by the data source (see [below for nested schema](#nestedatt--result))
34+
35+
<a id="nestedatt--result"></a>
36+
### Nested Schema for `result`
37+
38+
Read-Only:
39+
40+
- `created_on` (String) The RFC 3339 timestamp of when the list was created.
41+
- `description` (String) An informative summary of the list.
42+
- `id` (String) The unique ID of the list.
43+
- `kind` (String) The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
44+
Available values: "ip", "redirect", "hostname", "asn".
45+
- `modified_on` (String) The RFC 3339 timestamp of when the list was last modified.
46+
- `name` (String) An informative name for the list. Use this name in filter and rule expressions.
47+
- `num_items` (Number) The number of items in the list.
48+
- `num_referencing_filters` (Number) The number of [filters](/operations/filters-list-filters) referencing the list.
49+
50+

0 commit comments

Comments
 (0)