-
Notifications
You must be signed in to change notification settings - Fork 630
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2140 from cloudflare/migrate-more-docs-to-autogen
Migrate remaining resource docs to auto generation
- Loading branch information
Showing
140 changed files
with
2,470 additions
and
2,972 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,84 @@ | ||
| --- | ||
| layout: "cloudflare" | ||
| page_title: "Cloudflare: cloudflare_authenticated_origin_pulls" | ||
| description: Provides a Cloudflare Authenticated Origin Pulls resource. | ||
| page_title: "cloudflare_authenticated_origin_pulls Resource - Cloudflare" | ||
| subcategory: "" | ||
| description: |- | ||
| Provides a Cloudflare Authenticated Origin Pulls resource. A cloudflare_authenticated_origin_pulls | ||
| resource is required to use Per-Zone or Per-Hostname Authenticated | ||
| Origin Pulls. | ||
| --- | ||
|
|
||
| # cloudflare_authenticated_origin_pulls | ||
| # cloudflare_authenticated_origin_pulls (Resource) | ||
|
|
||
| Provides a Cloudflare Authenticated Origin Pulls resource. An `cloudflare_authenticated_origin_pulls` resource is required to use Per-Zone or Per-Hostname Authenticated Origin Pulls. | ||
| Provides a Cloudflare Authenticated Origin Pulls resource. A `cloudflare_authenticated_origin_pulls` | ||
| resource is required to use Per-Zone or Per-Hostname Authenticated | ||
| Origin Pulls. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| The arguments that you provide determine which form of Authenticated Origin Pulls to use: | ||
|
|
||
| ```hcl | ||
| ```terraform | ||
| # Authenticated Origin Pulls | ||
| resource "cloudflare_authenticated_origin_pulls" "my_aop" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| enabled = true | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| enabled = true | ||
| } | ||
| # Per-Zone Authenticated Origin Pulls | ||
| resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_zone_aop_cert" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| certificate = "-----INSERT CERTIFICATE-----" | ||
| private_key = "-----INSERT PRIVATE KEY-----" | ||
| type = "per-zone" | ||
| } | ||
| resource "cloudflare_authenticated_origin_pulls" "my_per_zone_aop" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| authenticated_origin_pulls_certificate = cloudflare_authenticated_origin_pulls_certificate.my_per_zone_aop_cert.id | ||
| enabled = true | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| authenticated_origin_pulls_certificate = cloudflare_authenticated_origin_pulls_certificate.my_per_zone_aop_cert.id | ||
| enabled = true | ||
| } | ||
| # Per-Hostname Authenticated Origin Pulls | ||
| resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_hostname_aop_cert" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| certificate = "-----INSERT CERTIFICATE-----" | ||
| private_key = "-----INSERT PRIVATE KEY-----" | ||
| type = "per-hostname" | ||
| } | ||
| resource "cloudflare_authenticated_origin_pulls" "my_per_hostname_aop" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| authenticated_origin_pulls_certificate = cloudflare_authenticated_origin_pulls_certificate.my_per_hostname_aop_cert.id | ||
| hostname = "aop.example.com" | ||
| enabled = true | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| authenticated_origin_pulls_certificate = cloudflare_authenticated_origin_pulls_certificate.my_per_hostname_aop_cert.id | ||
| hostname = "aop.example.com" | ||
| enabled = true | ||
| } | ||
| ``` | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `enabled` (Boolean) Whether to enable Authenticated Origin Pulls on the given zone or hostname. | ||
| - `zone_id` (String) The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.** | ||
|
|
||
| ## Argument Reference | ||
| ### Optional | ||
|
|
||
| The following arguments are supported: | ||
| - `authenticated_origin_pulls_certificate` (String) The ID of an uploaded Authenticated Origin Pulls certificate. If no hostname is provided, this certificate will be used zone wide as Per-Zone Authenticated Origin Pulls. | ||
| - `hostname` (String) Specify a hostname to enable Per-Hostname Authenticated Origin Pulls on, using the provided certificate. | ||
|
|
||
| - `zone_id` - (Required) The zone ID to upload the certificate to. | ||
| - `authenticated_origin_pulls_certificate` - (Optional) The id of an uploaded Authenticated Origin Pulls certificate. If no hostname is provided, this certificate will be used zone wide as Per-Zone Authenticated Origin Pulls. | ||
| - `hostname` - (Optional) Specify a hostname to enable Per-Hostname Authenticated Origin Pulls on, using the provided certificate. | ||
| - `enabled` - (Required) Whether or not to enable Authenticated Origin Pulls on the given zone or hostname. | ||
| ### Read-Only | ||
|
|
||
| - `id` (String) The ID of this resource. | ||
|
|
||
| ## Import | ||
|
|
||
| Authenticated Origin Pull configuration can be imported using a composite ID formed of the zone ID, the form of Authenticated Origin Pulls, and the certificate ID, with each section filled or left blank e.g. | ||
| Import is supported using the following syntax: | ||
|
|
||
| ``` | ||
| # Import Authenticated Origin Pull configuration | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.my_aop 023e105f4ecef8ad9ca31a8372d0c353// | ||
| ```shell | ||
| # Authenticated Origin Pull configuration | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.my_aop <zone_id>// | ||
|
|
||
| # Import Per-Zone Authenticated Origin Pull configuration | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.my_per_zone_aop 023e105f4ecef8ad9ca31a8372d0c353/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60/ | ||
| # Per-Zone Authenticated Origin Pull configuration | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.my_per_zone_aop <zone_id>/<certificate_id>/ | ||
|
|
||
| # Import Per-Hostname Authenticated Origin Pull configuration | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.my_per_hostname_aop 023e105f4ecef8ad9ca31a8372d0c353/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60/aop.example.com | ||
| # Per-Hostname Authenticated Origin Pull configuration | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.my_per_hostname_aop <zone_id>/<certificate_id>/<hostname> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,72 @@ | ||
| --- | ||
| layout: "cloudflare" | ||
| page_title: "Cloudflare: cloudflare_authenticated_origin_pulls_certificate" | ||
| description: Provides a Cloudflare Authenticated Origin Pulls certificate resource. | ||
| page_title: "cloudflare_authenticated_origin_pulls_certificate Resource - Cloudflare" | ||
| subcategory: "" | ||
| description: |- | ||
| Provides a Cloudflare Authenticated Origin Pulls certificate | ||
| resource. An uploaded client certificate is required to use Per-Zone | ||
| or Per-Hostname Authenticated Origin Pulls. | ||
| --- | ||
|
|
||
| # cloudflare_authenticated_origin_pulls_certificate | ||
| # cloudflare_authenticated_origin_pulls_certificate (Resource) | ||
|
|
||
| Provides a Cloudflare Authenticated Origin Pulls certificate resource. An uploaded client certificate is required to use Per-Zone or Per-Hostname Authenticated Origin Pulls. | ||
| Provides a Cloudflare Authenticated Origin Pulls certificate | ||
| resource. An uploaded client certificate is required to use Per-Zone | ||
| or Per-Hostname Authenticated Origin Pulls. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```hcl | ||
| ```terraform | ||
| # Per-Zone Authenticated Origin Pulls certificate | ||
| resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_zone_aop_cert" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| certificate = "-----INSERT CERTIFICATE-----" | ||
| private_key = "-----INSERT PRIVATE KEY-----" | ||
| type = "per-zone" | ||
| } | ||
| # Per-Hostname Authenticated Origin Pulls certificate | ||
| resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_hostname_aop_cert" { | ||
| zone_id = "${var.cloudflare_zone_id}" | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| certificate = "-----INSERT CERTIFICATE-----" | ||
| private_key = "-----INSERT PRIVATE KEY-----" | ||
| type = "per-hostname" | ||
| } | ||
| ``` | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ## Argument Reference | ||
| ### Required | ||
|
|
||
| The following arguments are supported: | ||
| - `certificate` (String) The public client certificate. **Modifying this attribute will force creation of a new resource.** | ||
| - `private_key` (String, Sensitive) The private key of the client certificate. **Modifying this attribute will force creation of a new resource.** | ||
| - `type` (String) The form of Authenticated Origin Pulls to upload the certificate to. Available values: `per-zone`, `per-hostname`. **Modifying this attribute will force creation of a new resource.** | ||
| - `zone_id` (String) The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.** | ||
|
|
||
| - `zone_id` - (Required) The zone ID to upload the certificate to. | ||
| - `certificate` - (Required) The public client certificate. | ||
| - `private_key` - (Required) The private key of the client certificate. | ||
| - `type` - (Required) The form of Authenticated Origin Pulls to upload the certificate to. | ||
| ### Optional | ||
|
|
||
| ## Import | ||
| - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) | ||
|
|
||
| Authenticated Origin Pull certificates can be imported using a composite ID formed of the zone ID, the form of Authenticated Origin Pulls, and the certificate ID, e.g. | ||
| ### Read-Only | ||
|
|
||
| ``` | ||
| # Import Per-Zone Authenticated Origin Pull certificate | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 023e105f4ecef8ad9ca31a8372d0c353/per-zone/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 | ||
| - `expires_on` (String) **Modifying this attribute will force creation of a new resource.** | ||
| - `id` (String) The ID of this resource. | ||
| - `issuer` (String) **Modifying this attribute will force creation of a new resource.** | ||
| - `serial_number` (String) **Modifying this attribute will force creation of a new resource.** | ||
| - `signature` (String) **Modifying this attribute will force creation of a new resource.** | ||
| - `status` (String) **Modifying this attribute will force creation of a new resource.** | ||
| - `uploaded_on` (String) **Modifying this attribute will force creation of a new resource.** | ||
|
|
||
| <a id="nestedblock--timeouts"></a> | ||
| ### Nested Schema for `timeouts` | ||
|
|
||
| Optional: | ||
|
|
||
| - `create` (String) | ||
|
|
||
| ## Import | ||
|
|
||
| Import is supported using the following syntax: | ||
|
|
||
| # Import Per-Hostname Authenticated Origin Pull certificate | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 023e105f4ecef8ad9ca31a8372d0c353/per-hostname/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 | ||
| ```shell | ||
| $ terraform import cloudflare_authenticated_origin_pulls_certificate.2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 <zone_id>/<certificate_type>/<certificate_id> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,39 @@ | ||
| --- | ||
| layout: "cloudflare" | ||
| page_title: "Cloudflare: cloudflare_custom_hostname_fallback_origin" | ||
| description: Provides a Cloudflare custom hostname fallback origin resource. | ||
| page_title: "cloudflare_custom_hostname_fallback_origin Resource - Cloudflare" | ||
| subcategory: "" | ||
| description: |- | ||
| Provides a Cloudflare custom hostname fallback origin resource. | ||
| --- | ||
|
|
||
| # cloudflare_custom_hostname_fallback_origin | ||
| # cloudflare_custom_hostname_fallback_origin (Resource) | ||
|
|
||
| Provides a Cloudflare custom hostname fallback origin resource. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```hcl | ||
| resource "cloudflare_custom_hostname_fallback_origin" "fallback_origin" { | ||
| zone_id = "d41d8cd98f00b204e9800998ecf8427e" | ||
| origin = "fallback.example.com" | ||
| ```terraform | ||
| resource "cloudflare_custom_hostname_fallback_origin" "example" { | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| origin = "fallback.example.com" | ||
| } | ||
| ``` | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ## Argument Reference | ||
| ### Required | ||
|
|
||
| The following arguments are supported: | ||
| - `origin` (String) Hostname you intend to fallback requests to. Origin must be a proxied A/AAAA/CNAME DNS record within Clouldflare. | ||
| - `zone_id` (String) The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.** | ||
|
|
||
| - `zone_id` - (Required) The DNS zone ID where the custom hostname should be assigned. | ||
| - `origin` - (Required) Hostname you intend to fallback requests to. Origin must be a proxied A/AAAA/CNAME DNS record within Clouldflare. | ||
| ### Read-Only | ||
|
|
||
| ## Attributes Reference | ||
|
|
||
| The following attribute is exported: | ||
|
|
||
| - `status` - Status of the fallback origin's activation. | ||
| - `id` (String) The ID of this resource. | ||
| - `status` (String) Status of the fallback origin's activation. | ||
|
|
||
| ## Import | ||
|
|
||
| Custom hostname fallback origins can be imported using a composite ID formed of the zone ID and [fallback origin](https://api.cloudflare.com/#custom-hostname-fallback-origin-for-a-zone-properties), | ||
| separated by a "/" e.g. | ||
| Import is supported using the following syntax: | ||
|
|
||
| ``` | ||
| $ terraform import cloudflare_custom_hostname_fallback_origin.example d41d8cd98f00b204e9800998ecf8427e/fallback.example.com | ||
| ```shell | ||
| $ terraform import cloudflare_custom_hostname_fallback_origin.example <zone_id>/<fallback_hostname> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,46 @@ | ||
| --- | ||
| layout: "cloudflare" | ||
| page_title: "Cloudflare: cloudflare_custom_pages" | ||
| description: Provides a resource which manages Cloudflare custom pages. | ||
| page_title: "cloudflare_custom_pages Resource - Cloudflare" | ||
| subcategory: "" | ||
| description: |- | ||
| Provides a resource which manages Cloudflare custom error pages. | ||
| --- | ||
|
|
||
| # cloudflare_custom_pages | ||
| # cloudflare_custom_pages (Resource) | ||
|
|
||
| Provides a resource which manages Cloudflare custom error pages. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```hcl | ||
| resource "cloudflare_custom_pages" "basic_challenge" { | ||
| zone_id = "d41d8cd98f00b204e9800998ecf8427e" | ||
| ```terraform | ||
| resource "cloudflare_custom_pages" "example" { | ||
| zone_id = "0da42c8d2132a9ddaf714f9e7c920711" | ||
| type = "basic_challenge" | ||
| url = "https://example.com/challenge.html" | ||
| state = "customized" | ||
| } | ||
| ``` | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ## Argument Reference | ||
| ### Required | ||
|
|
||
| The following arguments are supported: | ||
| - `type` (String) The type of custom page you wish to update. Available values: `basic_challenge`, `waf_challenge`, `waf_block`, `ratelimit_block`, `country_challenge`, `ip_block`, `under_attack`, `500_errors`, `1000_errors`, `always_online`, `managed_challenge`. | ||
| - `url` (String) URL of where the custom page source is located. | ||
|
|
||
| - `zone_id` - (Optional) The zone ID where the custom pages should be | ||
| updated. Either `zone_id` or `account_id` must be provided. | ||
| - `account_id` - (Optional) The account ID where the custom pages should be | ||
| updated. Either `account_id` or `zone_id` must be provided. If | ||
| `account_id` is present, it will override the zone setting. | ||
| - `type` - (Required) The type of custom page you wish to update. Must | ||
| be one of `basic_challenge`, `waf_challenge`, `waf_block`, | ||
| `ratelimit_block`, `country_challenge`, `ip_block`, `under_attack`, | ||
| `500_errors`, `1000_errors`, `always_online`, `managed_challenge`. | ||
| - `url` - (Required) URL of where the custom page source is located. | ||
| - `state` - (Required) Managed state of the custom page. Must be one of | ||
| `default`, `customized`. If the value is `default` it will be removed | ||
| from the Terraform state management. | ||
| ### Optional | ||
|
|
||
| ## Import | ||
|
|
||
| Custom pages can be imported using a composite ID formed of: | ||
| - `account_id` (String) The account identifier to target for the resource. Conflicts with `zone_id`. | ||
| - `state` (String) Managed state of the custom page. Available values: `default`, `customized`. | ||
| - `zone_id` (String) The zone identifier to target for the resource. Conflicts with `account_id`. | ||
|
|
||
| - `customPageLevel` - Either `account` or `zone`. | ||
| - `identifier` - The ID of the account or zone you intend to manage. | ||
| - `pageType` - The value from the `type` argument. | ||
| ### Read-Only | ||
|
|
||
| Example for a zone: | ||
| - `id` (String) The ID of this resource. | ||
|
|
||
| ``` | ||
| $ terraform import cloudflare_custom_pages.basic_challenge zone/d41d8cd98f00b204e9800998ecf8427e/basic_challenge | ||
| ``` | ||
| ## Import | ||
|
|
||
| Example for an account: | ||
| Import is supported using the following syntax: | ||
|
|
||
| ``` | ||
| $ terraform import cloudflare_custom_pages.basic_challenge account/e268443e43d93dab7ebef303bbe9642f/basic_challenge | ||
| ```shell | ||
| $ terraform import cloudflare_custom_pages.example <resource_level>/<resource_id>/<custom_page_type> | ||
| ``` |
Oops, something went wrong.