Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz committed Dec 18, 2024
1 parent 932e9a4 commit 5c30d13
Show file tree
Hide file tree
Showing 33 changed files with 143 additions and 165 deletions.
12 changes: 1 addition & 11 deletions docs/data-sources/account_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Read-Only:
- `effect` (String) Allow or deny operations against the resources.
- `id` (String) Policy identifier.
- `permission_groups` (Attributes List) A set of permission groups that are specified to the policy. (see [below for nested schema](#nestedatt--policies--permission_groups))
- `resources` (Attributes) A list of resource names that the policy applies to. (see [below for nested schema](#nestedatt--policies--resources))
- `resources` (Map of String) A list of resource names that the policy applies to.

<a id="nestedatt--policies--permission_groups"></a>
### Nested Schema for `policies.permission_groups`
Expand All @@ -97,13 +97,3 @@ Read-Only:
- `value` (String)



<a id="nestedatt--policies--resources"></a>
### Nested Schema for `policies.resources`

Read-Only:

- `resource` (String)
- `scope` (String)


12 changes: 1 addition & 11 deletions docs/data-sources/account_tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Read-Only:
- `effect` (String) Allow or deny operations against the resources.
- `id` (String) Policy identifier.
- `permission_groups` (Attributes List) A set of permission groups that are specified to the policy. (see [below for nested schema](#nestedatt--result--policies--permission_groups))
- `resources` (Attributes) A list of resource names that the policy applies to. (see [below for nested schema](#nestedatt--result--policies--resources))
- `resources` (Map of String) A list of resource names that the policy applies to.

<a id="nestedatt--result--policies--permission_groups"></a>
### Nested Schema for `result.policies.permission_groups`
Expand All @@ -95,13 +95,3 @@ Read-Only:
- `value` (String)



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

Read-Only:

- `resource` (String)
- `scope` (String)


8 changes: 1 addition & 7 deletions docs/data-sources/api_shield_operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,10 @@ description: |-

```terraform
data "cloudflare_api_shield_operation" "example_api_shield_operation" {
zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
diff = true
direction = "asc"
endpoint = "/api/v1"
host = ["api.cloudflare.com"]
method = ["GET"]
order = "host"
origin = "ML"
page = 1
per_page = 5
origin = []
state = "review"
}
```
Expand Down
12 changes: 1 addition & 11 deletions docs/data-sources/api_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Read-Only:
- `effect` (String) Allow or deny operations against the resources.
- `id` (String) Policy identifier.
- `permission_groups` (Attributes List) A set of permission groups that are specified to the policy. (see [below for nested schema](#nestedatt--policies--permission_groups))
- `resources` (Attributes) A list of resource names that the policy applies to. (see [below for nested schema](#nestedatt--policies--resources))
- `resources` (Map of String) A list of resource names that the policy applies to.

<a id="nestedatt--policies--permission_groups"></a>
### Nested Schema for `policies.permission_groups`
Expand All @@ -91,13 +91,3 @@ Read-Only:
- `value` (String)



<a id="nestedatt--policies--resources"></a>
### Nested Schema for `policies.resources`

Read-Only:

- `resource` (String)
- `scope` (String)


12 changes: 1 addition & 11 deletions docs/data-sources/api_tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Read-Only:
- `effect` (String) Allow or deny operations against the resources.
- `id` (String) Policy identifier.
- `permission_groups` (Attributes List) A set of permission groups that are specified to the policy. (see [below for nested schema](#nestedatt--result--policies--permission_groups))
- `resources` (Attributes) A list of resource names that the policy applies to. (see [below for nested schema](#nestedatt--result--policies--resources))
- `resources` (Map of String) A list of resource names that the policy applies to.

<a id="nestedatt--result--policies--permission_groups"></a>
### Nested Schema for `result.policies.permission_groups`
Expand All @@ -90,13 +90,3 @@ Read-Only:
- `value` (String)



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

Read-Only:

- `resource` (String)
- `scope` (String)


6 changes: 0 additions & 6 deletions docs/data-sources/cloudforce_one_request_message.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@ description: |-
data "cloudflare_cloudforce_one_request_message" "example_cloudforce_one_request_message" {
account_identifier = "023e105f4ecef8ad9ca31a8372d0c353"
request_identifier = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
page = 0
per_page = 10
after = "2022-01-01T00:00:00Z"
before = "2024-01-01T00:00:00Z"
sort_by = "created"
sort_order = "asc"
}
```

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 @@ -29,10 +29,15 @@ 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.
- `content` (String) A valid IPv4 address.
- `data` (Attributes) Components of a CAA record. (see [below for nested schema](#nestedatt--data))
- `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.
- `settings` (Attributes) (see [below for nested schema](#nestedatt--settings))
- `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.
- `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.

<a id="nestedatt--filter"></a>
Expand Down Expand Up @@ -154,5 +159,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.
- `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.


9 changes: 8 additions & 1 deletion docs/data-sources/dns_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,15 @@ Optional:

Read-Only:

- `comment` (String) Comments or notes about the DNS record. This field has no effect on DNS responses.
- `content` (String) A valid IPv4 address.
- `data` (Attributes) Components of a CAA record. (see [below for nested schema](#nestedatt--result--data))
- `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.
- `settings` (Attributes) (see [below for nested schema](#nestedatt--result--settings))
- `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.
- `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.

<a id="nestedatt--result--data"></a>
Expand Down Expand Up @@ -181,5 +186,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.
- `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.


4 changes: 2 additions & 2 deletions docs/data-sources/email_security_block_sender.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ data "cloudflare_email_security_block_sender" "example_email_security_block_send

- `account_id` (String) Account Identifier
- `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))
- `pattern_id` (Number)
- `pattern_id` (Number) The unique identifier for the allow policy.

### Read-Only

- `comments` (String)
- `created_at` (String)
- `id` (Number) The ID of this resource.
- `id` (Number) The unique identifier for the allow policy.
- `is_regex` (Boolean)
- `last_modified` (String)
- `pattern` (String)
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/email_security_block_senders.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Read-Only:

- `comments` (String)
- `created_at` (String)
- `id` (Number)
- `id` (Number) The unique identifier for the allow policy.
- `is_regex` (Boolean)
- `last_modified` (String)
- `pattern` (String)
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/magic_transit_site_wan.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ data "cloudflare_magic_transit_site_wan" "example_magic_transit_site_wan" {

### Read-Only

- `health_check_rate` (String) Magic WAN health check rate for tunnels created on this link. The default value is `mid`.
- `id` (String) Identifier
- `name` (String)
- `physport` (Number)
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/magic_transit_site_wans.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ data "cloudflare_magic_transit_site_wans" "example_magic_transit_site_wans" {

Read-Only:

- `health_check_rate` (String) Magic WAN health check rate for tunnels created on this link. The default value is `mid`.
- `id` (String) Identifier
- `name` (String)
- `physport` (Number)
Expand Down
10 changes: 8 additions & 2 deletions docs/data-sources/zero_trust_access_infrastructure_target.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,18 @@ Required:

Optional:

- `created_after` (String) Date and time at which the target was created
- `created_after` (String) Date and time at which the target was created after (inclusive)
- `created_before` (String) Date and time at which the target was created before (inclusive)
- `direction` (String) The sorting direction.
- `hostname` (String) Hostname of a target
- `hostname_contains` (String) Partial match to the hostname of a target
- `ip_v4` (String) IPv4 address of the target
- `ip_v6` (String) IPv6 address of the target
- `modified_after` (String) Date and time at which the target was modified
- `ips` (List of String) Filters for targets that have any of the following IP addresses. Specify
`ips` multiple times in query parameter to build list of candidates.
- `modified_after` (String) Date and time at which the target was modified after (inclusive)
- `modified_before` (String) Date and time at which the target was modified before (inclusive)
- `order` (String) The field to sort by.
- `virtual_network_id` (String) Private virtual network identifier of the target


Expand Down
15 changes: 13 additions & 2 deletions docs/data-sources/zero_trust_access_infrastructure_targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,16 @@ description: |-
data "cloudflare_zero_trust_access_infrastructure_targets" "example_zero_trust_access_infrastructure_targets" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
created_after = "2019-12-27T18:11:19.117Z"
created_before = "2019-12-27T18:11:19.117Z"
direction = "asc"
hostname = "hostname"
hostname_contains = "hostname_contains"
ip_v4 = "ip_v4"
ip_v6 = "ip_v6"
ips = ["string"]
modified_after = "2019-12-27T18:11:19.117Z"
modified_before = "2019-12-27T18:11:19.117Z"
order = "hostname"
virtual_network_id = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
```
Expand All @@ -33,13 +38,19 @@ data "cloudflare_zero_trust_access_infrastructure_targets" "example_zero_trust_a

### Optional

- `created_after` (String) Date and time at which the target was created
- `created_after` (String) Date and time at which the target was created after (inclusive)
- `created_before` (String) Date and time at which the target was created before (inclusive)
- `direction` (String) The sorting direction.
- `hostname` (String) Hostname of a target
- `hostname_contains` (String) Partial match to the hostname of a target
- `ip_v4` (String) IPv4 address of the target
- `ip_v6` (String) IPv6 address of the target
- `ips` (List of String) Filters for targets that have any of the following IP addresses. Specify
`ips` multiple times in query parameter to build list of candidates.
- `max_items` (Number) Max items to fetch, default: 1000
- `modified_after` (String) Date and time at which the target was modified
- `modified_after` (String) Date and time at which the target was modified after (inclusive)
- `modified_before` (String) Date and time at which the target was modified before (inclusive)
- `order` (String) The field to sort by.
- `virtual_network_id` (String) Private virtual network identifier of the target

### Read-Only
Expand Down
4 changes: 3 additions & 1 deletion docs/data-sources/zero_trust_dlp_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ data "cloudflare_zero_trust_dlp_dataset" "example_zero_trust_dlp_dataset" {
- `num_cells` (Number)
- `secret` (Boolean)
- `status` (String)
- `updated_at` (String)
- `updated_at` (String) When the dataset was last updated.

This includes name or description changes as well as uploads.
- `uploads` (Attributes List) (see [below for nested schema](#nestedatt--uploads))

<a id="nestedatt--filter"></a>
Expand Down
4 changes: 3 additions & 1 deletion docs/data-sources/zero_trust_dlp_datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ Read-Only:
- `num_cells` (Number)
- `secret` (Boolean)
- `status` (String)
- `updated_at` (String)
- `updated_at` (String) When the dataset was last updated.

This includes name or description changes as well as uploads.
- `uploads` (Attributes List) (see [below for nested schema](#nestedatt--result--uploads))

<a id="nestedatt--result--columns"></a>
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/zero_trust_dns_location.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ data "cloudflare_zero_trust_dns_location" "example_zero_trust_dns_location" {
- `client_default` (Boolean) True if the location is the default location.
- `created_at` (String)
- `dns_destination_ips_id` (String) The identifier of the pair of IPv4 addresses assigned to this location.
- `dns_destination_ipv6_block_id` (String) The uuid identifier of the IPv6 block brought to the gateway, so that this location's IPv6 address is allocated from the Bring Your Own Ipv6(BYOIPv6) block and not from the standard CloudFlare IPv6 block.
- `doh_subdomain` (String) The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway.
- `ecs_support` (Boolean) True if the location needs to resolve EDNS queries.
- `endpoints` (Attributes) The destination endpoints configured for this location. When updating a location, if this field is absent or set with null, the endpoints configuration remains unchanged. (see [below for nested schema](#nestedatt--endpoints))
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/zero_trust_dns_locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Read-Only:
- `client_default` (Boolean) True if the location is the default location.
- `created_at` (String)
- `dns_destination_ips_id` (String) The identifier of the pair of IPv4 addresses assigned to this location.
- `dns_destination_ipv6_block_id` (String) The uuid identifier of the IPv6 block brought to the gateway, so that this location's IPv6 address is allocated from the Bring Your Own Ipv6(BYOIPv6) block and not from the standard CloudFlare IPv6 block.
- `doh_subdomain` (String) The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway.
- `ecs_support` (Boolean) True if the location needs to resolve EDNS queries.
- `endpoints` (Attributes) The destination endpoints configured for this location. When updating a location, if this field is absent or set with null, the endpoints configuration remains unchanged. (see [below for nested schema](#nestedatt--result--endpoints))
Expand Down
15 changes: 3 additions & 12 deletions docs/resources/account_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ resource "cloudflare_account_token" "example_account_token" {
name = "Magic Network Monitoring"
}]
resources = {
resource = "resource"
scope = "scope"
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43" = "*"
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4" = "*"
}
}]
condition = {
Expand Down Expand Up @@ -80,7 +80,7 @@ Required:

- `effect` (String) Allow or deny operations against the resources.
- `permission_groups` (Attributes List) A set of permission groups that are specified to the policy. (see [below for nested schema](#nestedatt--policies--permission_groups))
- `resources` (Attributes) A list of resource names that the policy applies to. (see [below for nested schema](#nestedatt--policies--resources))
- `resources` (Map of String) A list of resource names that the policy applies to.

Read-Only:

Expand Down Expand Up @@ -108,15 +108,6 @@ Optional:



<a id="nestedatt--policies--resources"></a>
### Nested Schema for `policies.resources`

Optional:

- `resource` (String)
- `scope` (String)



<a id="nestedatt--condition"></a>
### Nested Schema for `condition`
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/api_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ resource "cloudflare_api_token" "example_api_token" {
name = "Magic Network Monitoring"
}]
resources = {
resource = "resource"
scope = "scope"
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43" = "*"
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4" = "*"
}
}]
condition = {
Expand Down
13 changes: 12 additions & 1 deletion docs/resources/dns_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,16 @@ description: |-
```terraform
resource "cloudflare_dns_record" "example_dns_record" {
zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
comment = "Domain verification record"
content = "198.51.100.4"
name = "example.com"
proxied = true
settings = {
ipv4_only = true
ipv6_only = true
}
tags = ["owner:dns-team"]
ttl = 3600
type = "A"
}
```
Expand All @@ -36,7 +45,7 @@ resource "cloudflare_dns_record" "example_dns_record" {
- `data` (Attributes) Components of a CAA record. (see [below for nested schema](#nestedatt--data))
- `priority` (Number) Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
- `proxied` (Boolean) Whether the record is receiving the performance and security benefits of Cloudflare.
- `settings` (Attributes) (see [below for nested schema](#nestedatt--settings))
- `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.

### Read-Only
Expand Down Expand Up @@ -98,5 +107,7 @@ Optional:
Optional:

- `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.
- `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.


Loading

0 comments on commit 5c30d13

Please sign in to comment.