Skip to content

Commit a060e61

Browse files
chore(docs): update documentation (#6523)
1 parent bc526ff commit a060e61

Some content is hidden

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

48 files changed

+948
-142
lines changed

docs/data-sources/account_subscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Read-Only:
4545
- `currency` (String) The currency applied to the rate plan subscription.
4646
- `externally_managed` (Boolean) Whether this rate plan is managed externally from Cloudflare.
4747
- `id` (String) The ID of the rate plan.
48-
Available values: "free", "lite", "pro", "pro_plus", "business", "enterprise", "partners_free", "partners_pro", "partners_business", "partners_enterprise".
48+
Available values: "free", "lite", "pro", "pro_plus", "business", "enterprise", "partners_free", "partners_pro", "partners_business", "partners_ent".
4949
- `is_contract` (Boolean) Whether a rate plan is enterprise-based (or newly adopted term contract).
5050
- `public_name` (String) The full name of the rate plan.
5151
- `scope` (String) The scope that this rate plan applies to.

docs/data-sources/certificate_pack.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,86 @@ data "cloudflare_certificate_pack" "example_certificate_pack" {
2323

2424
### Required
2525

26-
- `certificate_pack_id` (String) Identifier.
2726
- `zone_id` (String) Identifier.
2827

28+
### Optional
29+
30+
- `certificate_pack_id` (String) Identifier.
31+
- `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))
32+
2933
### Read-Only
3034

35+
- `certificate_authority` (String) Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
36+
Available values: "google", "lets_encrypt", "ssl_com".
37+
- `certificates` (Attributes List) Array of certificates in this pack. (see [below for nested schema](#nestedatt--certificates))
38+
- `cloudflare_branding` (Boolean) Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.
39+
- `hosts` (List of String) Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
3140
- `id` (String) Identifier.
41+
- `primary_certificate` (String) Identifier of the primary certificate in a pack.
42+
- `status` (String) Status of certificate pack.
43+
Available values: "initializing", "pending_validation", "deleted", "pending_issuance", "pending_deployment", "pending_deletion", "pending_expiration", "expired", "active", "initializing_timed_out", "validation_timed_out", "issuance_timed_out", "deployment_timed_out", "deletion_timed_out", "pending_cleanup", "staging_deployment", "staging_active", "deactivating", "inactive", "backup_issued", "holding_deployment".
44+
- `type` (String) Type of certificate pack.
45+
Available values: "mh_custom", "managed_hostname", "sni_custom", "universal", "advanced", "total_tls", "keyless", "legacy_custom".
46+
- `validation_errors` (Attributes List) Domain validation errors that have been received by the certificate authority (CA). (see [below for nested schema](#nestedatt--validation_errors))
47+
- `validation_method` (String) Validation Method selected for the order.
48+
Available values: "txt", "http", "email".
49+
- `validation_records` (Attributes List) Certificates' validation records. (see [below for nested schema](#nestedatt--validation_records))
50+
- `validity_days` (Number) Validity Days selected for the order.
51+
Available values: 14, 30, 90, 365.
52+
53+
<a id="nestedatt--filter"></a>
54+
### Nested Schema for `filter`
55+
56+
Optional:
57+
58+
- `status` (String) Include Certificate Packs of all statuses, not just active ones.
59+
Available values: "all".
60+
61+
62+
<a id="nestedatt--certificates"></a>
63+
### Nested Schema for `certificates`
64+
65+
Read-Only:
66+
67+
- `bundle_method` (String) Certificate bundle method.
68+
- `expires_on` (String) When the certificate from the authority expires.
69+
- `geo_restrictions` (Attributes) Specify the region where your private key can be held locally. (see [below for nested schema](#nestedatt--certificates--geo_restrictions))
70+
- `hosts` (List of String) Hostnames covered by this certificate.
71+
- `id` (String) Certificate identifier.
72+
- `issuer` (String) The certificate authority that issued the certificate.
73+
- `modified_on` (String) When the certificate was last modified.
74+
- `priority` (Number) The order/priority in which the certificate will be used.
75+
- `signature` (String) The type of hash used for the certificate.
76+
- `status` (String) Certificate status.
77+
- `uploaded_on` (String) When the certificate was uploaded to Cloudflare.
78+
- `zone_id` (String) Identifier.
79+
80+
<a id="nestedatt--certificates--geo_restrictions"></a>
81+
### Nested Schema for `certificates.geo_restrictions`
82+
83+
Read-Only:
84+
85+
- `label` (String) Available values: "us", "eu", "highest_security".
86+
87+
88+
89+
<a id="nestedatt--validation_errors"></a>
90+
### Nested Schema for `validation_errors`
91+
92+
Read-Only:
93+
94+
- `message` (String) A domain validation error.
95+
96+
97+
<a id="nestedatt--validation_records"></a>
98+
### Nested Schema for `validation_records`
99+
100+
Read-Only:
101+
102+
- `emails` (List of String) The set of email addresses that the certificate authority (CA) will use to complete domain validation.
103+
- `http_body` (String) The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
104+
- `http_url` (String) The url that will be checked during domain validation.
105+
- `txt_name` (String) The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
106+
- `txt_value` (String) The TXT record that the certificate authority (CA) will check during domain validation.
32107

33108

docs/data-sources/certificate_packs.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,70 @@ Available values: "all".
3838
<a id="nestedatt--result"></a>
3939
### Nested Schema for `result`
4040

41+
Read-Only:
42+
43+
- `certificate_authority` (String) Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
44+
Available values: "google", "lets_encrypt", "ssl_com".
45+
- `certificates` (Attributes List) Array of certificates in this pack. (see [below for nested schema](#nestedatt--result--certificates))
46+
- `cloudflare_branding` (Boolean) Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.
47+
- `hosts` (List of String) Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
48+
- `id` (String) Identifier.
49+
- `primary_certificate` (String) Identifier of the primary certificate in a pack.
50+
- `status` (String) Status of certificate pack.
51+
Available values: "initializing", "pending_validation", "deleted", "pending_issuance", "pending_deployment", "pending_deletion", "pending_expiration", "expired", "active", "initializing_timed_out", "validation_timed_out", "issuance_timed_out", "deployment_timed_out", "deletion_timed_out", "pending_cleanup", "staging_deployment", "staging_active", "deactivating", "inactive", "backup_issued", "holding_deployment".
52+
- `type` (String) Type of certificate pack.
53+
Available values: "mh_custom", "managed_hostname", "sni_custom", "universal", "advanced", "total_tls", "keyless", "legacy_custom".
54+
- `validation_errors` (Attributes List) Domain validation errors that have been received by the certificate authority (CA). (see [below for nested schema](#nestedatt--result--validation_errors))
55+
- `validation_method` (String) Validation Method selected for the order.
56+
Available values: "txt", "http", "email".
57+
- `validation_records` (Attributes List) Certificates' validation records. (see [below for nested schema](#nestedatt--result--validation_records))
58+
- `validity_days` (Number) Validity Days selected for the order.
59+
Available values: 14, 30, 90, 365.
60+
61+
<a id="nestedatt--result--certificates"></a>
62+
### Nested Schema for `result.certificates`
63+
64+
Read-Only:
65+
66+
- `bundle_method` (String) Certificate bundle method.
67+
- `expires_on` (String) When the certificate from the authority expires.
68+
- `geo_restrictions` (Attributes) Specify the region where your private key can be held locally. (see [below for nested schema](#nestedatt--result--certificates--geo_restrictions))
69+
- `hosts` (List of String) Hostnames covered by this certificate.
70+
- `id` (String) Certificate identifier.
71+
- `issuer` (String) The certificate authority that issued the certificate.
72+
- `modified_on` (String) When the certificate was last modified.
73+
- `priority` (Number) The order/priority in which the certificate will be used.
74+
- `signature` (String) The type of hash used for the certificate.
75+
- `status` (String) Certificate status.
76+
- `uploaded_on` (String) When the certificate was uploaded to Cloudflare.
77+
- `zone_id` (String) Identifier.
78+
79+
<a id="nestedatt--result--certificates--geo_restrictions"></a>
80+
### Nested Schema for `result.certificates.geo_restrictions`
81+
82+
Read-Only:
83+
84+
- `label` (String) Available values: "us", "eu", "highest_security".
85+
86+
87+
88+
<a id="nestedatt--result--validation_errors"></a>
89+
### Nested Schema for `result.validation_errors`
90+
91+
Read-Only:
92+
93+
- `message` (String) A domain validation error.
94+
95+
96+
<a id="nestedatt--result--validation_records"></a>
97+
### Nested Schema for `result.validation_records`
98+
99+
Read-Only:
100+
101+
- `emails` (List of String) The set of email addresses that the certificate authority (CA) will use to complete domain validation.
102+
- `http_body` (String) The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
103+
- `http_url` (String) The url that will be checked during domain validation.
104+
- `txt_name` (String) The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
105+
- `txt_value` (String) The TXT record that the certificate authority (CA) will check during domain validation.
106+
41107

docs/data-sources/cloudforce_one_request_asset.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ data "cloudflare_cloudforce_one_request_asset" "example_cloudforce_one_request_a
3333
- `created` (String) Defines the asset creation time.
3434
- `description` (String) Asset description.
3535
- `file_type` (String) Asset file type.
36+
- `id` (String) UUID.
3637
- `name` (String) Asset name.
3738

3839

docs/data-sources/cloudforce_one_request_message.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Available values: "asc", "desc".
4747
- `author` (String) Author of message.
4848
- `content` (String) Content of message.
4949
- `created` (String) Defines the message creation time.
50+
- `id` (String) UUID.
5051
- `is_follow_on_request` (Boolean) Whether the message is a follow-on request.
5152
- `updated` (String) Defines the message last updated time.
5253

docs/data-sources/email_routing_dns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Available values: "A", "AAAA", "CNAME", "HTTPS", "TXT", "SRV", "LOC", "MX", "NS"
131131

132132
Read-Only:
133133

134-
- `count` (Number) Total number of results for the requested service.
134+
- `email_routing_dns_count` (Number) Total number of results for the requested service.
135135
- `page` (Number) Current page within paginated list of results.
136136
- `per_page` (Number) Number of results per page of results.
137137
- `total_count` (Number) Total results available without any search parameters.

docs/data-sources/pages_domain.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ data "cloudflare_pages_domain" "example_pages_domain" {
2424

2525
### Required
2626

27-
- `account_id` (String) Identifier
28-
- `domain_name` (String) Name of the domain.
27+
- `account_id` (String) Identifier.
28+
- `domain_name` (String) The domain name.
2929
- `project_name` (String) Name of the project.
3030

3131
### Read-Only
3232

3333
- `certificate_authority` (String) Available values: "google", "lets_encrypt".
3434
- `created_on` (String)
3535
- `domain_id` (String)
36-
- `id` (String) Name of the domain.
37-
- `name` (String)
36+
- `id` (String) The domain name.
37+
- `name` (String) The domain name.
3838
- `status` (String) Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
3939
- `validation_data` (Attributes) (see [below for nested schema](#nestedatt--validation_data))
4040
- `verification_data` (Attributes) (see [below for nested schema](#nestedatt--verification_data))

docs/data-sources/pages_domains.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ data "cloudflare_pages_domains" "example_pages_domains" {
2323

2424
### Required
2525

26-
- `account_id` (String) Identifier
26+
- `account_id` (String) Identifier.
2727
- `project_name` (String) Name of the project.
2828

2929
### Optional
@@ -43,7 +43,7 @@ Read-Only:
4343
- `created_on` (String)
4444
- `domain_id` (String)
4545
- `id` (String)
46-
- `name` (String)
46+
- `name` (String) The domain name.
4747
- `status` (String) Available values: "initializing", "pending", "active", "deactivated", "blocked", "error".
4848
- `validation_data` (Attributes) (see [below for nested schema](#nestedatt--result--validation_data))
4949
- `verification_data` (Attributes) (see [below for nested schema](#nestedatt--result--verification_data))

0 commit comments

Comments
 (0)