release: 5.4.0 (#5527)

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>
Co-authored-by: Jacob Bednarz <[email protected]>
Co-authored-by: Jacob Bednarz <[email protected]>
Co-authored-by: Cina Saffary <[email protected]>
Co-authored-by: meorphis <[email protected]>
Co-authored-by: David Ackerman <[email protected]>

Author: 5 people

.github/workflows/ci.yml

@@ -1,16 +1,16 @@
 name: CI
 on:
   push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-      - next
+    branches-ignore:
+      - 'generated'
+      - 'codegen/**'
+      - 'integrated/**'
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:
-    runs-on: lx64
+    runs-on: ${{ github.repository == 'stainless-sdks/cloudflare-terraform' && 'depot-ubuntu-24.04' || 'lx64' }}
     steps:
       - uses: actions/checkout@v4
 
@@ -26,7 +26,7 @@ jobs:
         run: ./scripts/lint
 
   test:
-    runs-on: lx64
+    runs-on: ${{ github.repository == 'stainless-sdks/cloudflare-terraform' && 'depot-ubuntu-24.04' || 'lx64' }}
     steps:
       - uses: actions/checkout@v4
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.3.0"
+  ".": "5.4.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 1707
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-6097206cf3de7c784cff3dff4b60492b70824915c5bcb712111a5b355f9349dc.yml
-openapi_spec_hash: 2ea12f49a88b823d2dca959b5112e50c
-config_hash: 6513c164fa0cced545d790fbd720f666
+configured_endpoints: 1713
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-1e19b3654a9835d48a6f365f6cbd1f564da9e0f1c82c5d1e3eaf1fee54e87d11.yml
+openapi_spec_hash: f340abaa8fa4e47f15da3109aa50529b
+config_hash: 92ed089a306b4e31a35318562d26d51a

CHANGELOG.md

@@ -1,16 +1,17 @@
 # Cloudflare Terraform Provider
 
-## Requirements
-
-Terraform 1.2 or newer. We recommend running the [latest version](https://developer.hashicorp.com/terraform/downloads?product_intent=terraform) for optimal compatibility with the Cloudflare provider. Terraform versions older than 1.2 have known issues with newer features and internals.
+The [Cloudflare Terraform provider](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs) provides convenient access to
+the [Cloudflare REST API](https://developers.cloudflare.com/api) from Terraform.
 
-## Documentation
+## Requirements
 
-Full, comprehensive documentation is available on the [Terraform Registry](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs). [API documentation](https://api.cloudflare.com) and [Developer documentation](https://developers.cloudflare.com) is also available
-for non-Terraform or service specific information.
+This provider requires Terraform CLI 1.0 or later. You can [install it for your system](https://developer.hashicorp.com/terraform/install)
+on Hashicorp's website.
 
 ## Usage
 
+Add the following to your `main.tf` file:
+
 <!-- x-release-please-start-version -->
 
 ```hcl
@@ -26,7 +27,14 @@ terraform {
 
 # Initialize the provider
 provider "cloudflare" {
+  # The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).
   api_token = "Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY" # or set CLOUDFLARE_API_TOKEN env variable
+  # The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
+  api_key = "144c9defac04969c7bfad8efaa8ea194" # or set CLOUDFLARE_API_KEY env variable
+  # The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
+  api_email = "[email protected]" # or set CLOUDFLARE_EMAIL env variable
+  # Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys).
+  user_service_key = "v1.0-144c9defac04969c7bfad8ef-631a41d003a32d25fe878081ef365c49503f7fada600da935e2851a1c7326084b85cbf6429c4b859de8475731dc92a9c329631e6d59e6c73da7b198497172b4cefe071d90d0f5d2719" # or set CLOUDFLARE_API_USER_SERVICE_KEY env variable
 }
 
 # Configure a resource
@@ -43,15 +51,32 @@ resource "cloudflare_zone" "example_zone" {
 
 Initialize your project by running `terraform init` in the directory.
 
-## Migrating to Terraform from using the Dashboard
+Additional examples can be found in the [./examples](./examples) folder within this repository, and you can
+refer to the full documentation on [the Terraform Registry](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs).
+
+### Provider Options
+
+When you initialize the provider, the following options are supported. It is recommended to use environment variables for sensitive values like access tokens.
+If an environment variable is provided, then the option does not need to be set in the terraform source.
+
+| Property         | Environment variable              | Required | Default value |
+| ---------------- | --------------------------------- | -------- | ------------- |
+| user_service_key | `CLOUDFLARE_API_USER_SERVICE_KEY` | false    | —             |
+| api_token        | `CLOUDFLARE_API_TOKEN`            | false    | —             |
+| api_key          | `CLOUDFLARE_API_KEY`              | false    | —             |
+| api_email        | `CLOUDFLARE_EMAIL`                | false    | —             |
+
+## Semantic versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
+2. Changes that we do not expect to impact the vast majority of users in practice.
 
-Do you have an existing Cloudflare account (or many!) that you'd like to transition
-to be managed via Terraform? Check out [cf-terraforming](https://github.com/cloudflare/cf-terraforming)
-which is a tool Cloudflare has built to help dump the existing resources and
-import them into Terraform.
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-## Maintenance
+We are keen for your feedback; please open an [issue](https://www.github.com/cloudflare/terraform-provider-cloudflare/issues) with questions, bugs, or suggestions.
 
-This SDK is actively maintained, however, many issues are tracked outside of GitHub on internal Cloudflare systems. Members of the community are welcome to join and discuss your issues during our weekly triage meetings. For urgent issues, please contact [Cloudflare support](https://www.support.cloudflare.com/s/?language=en_US). 
+## Contributing
 
-* [Community triage meeting](https://calendar.google.com/calendar/embed?src=c_dbf6ce250643f2e60f806d28f3fc09a9de24cbe0ab3ffb699838303d2adfc9e4%40group.calendar.google.com&ctz=America%2FLos_Angeles)
+See [the contributing documentation](./CONTRIBUTING.md).

README.md

@@ -26,15 +26,15 @@ data "cloudflare_access_rule" "example_access_rule" {
 
 - `account_id` (String) The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
 - `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))
-- `rule_id` (String) Unique identifier for a rule
+- `rule_id` (String) Unique identifier for a rule.
 - `zone_id` (String) The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
 
 ### Read-Only
 
 - `allowed_modes` (List of String) The available actions that a rule can apply to a matched request.
 - `configuration` (Attributes) The rule configuration. (see [below for nested schema](#nestedatt--configuration))
 - `created_on` (String) The timestamp of when the rule was created.
-- `id` (String) Unique identifier for a rule
+- `id` (String) Unique identifier for a rule.
 - `mode` (String) The action to apply to a matched request.
 Available values: "block", "challenge", "whitelist", "js_challenge", "managed_challenge".
 - `modified_on` (String) The timestamp of when the rule was last modified.
@@ -47,25 +47,25 @@ Available values: "block", "challenge", "whitelist", "js_challenge", "managed_ch
 Optional:
 
 - `configuration` (Attributes) (see [below for nested schema](#nestedatt--filter--configuration))
-- `direction` (String) The direction used to sort returned rules.
+- `direction` (String) Defines the direction used to sort returned rules.
 Available values: "asc", "desc".
-- `match` (String) When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
+- `match` (String) Defines the search requirements. When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
 Available values: "any", "all".
 - `mode` (String) The action to apply to a matched request.
 Available values: "block", "challenge", "whitelist", "js_challenge", "managed_challenge".
-- `notes` (String) The string to search for in the notes of existing IP Access rules.
+- `notes` (String) Defines the string to search for in the notes of existing IP Access rules.
 Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
-- `order` (String) The field used to sort returned rules.
+- `order` (String) Defines the field used to sort returned rules.
 Available values: "configuration.target", "configuration.value", "mode".
 
 <a id="nestedatt--filter--configuration"></a>
 ### Nested Schema for `filter.configuration`
 
 Optional:
 
-- `target` (String) The target to search in existing rules.
+- `target` (String) Defines the target to search in existing rules.
 Available values: "ip", "ip_range", "asn", "country".
-- `value` (String) The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
+- `value` (String) Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
 Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
 
 
@@ -86,8 +86,8 @@ Available values: "ip".
 Read-Only:
 
 - `email` (String) The contact email address of the user.
-- `id` (String) Identifier
-- `type` (String) The scope of the rule.
+- `id` (String) Defines an identifier.
+- `type` (String) Defines the scope of the rule.
 Available values: "user", "organization".
 
 

docs/data-sources/access_rule.md

@@ -33,16 +33,16 @@ data "cloudflare_access_rules" "example_access_rules" {
 
 - `account_id` (String) The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
 - `configuration` (Attributes) (see [below for nested schema](#nestedatt--configuration))
-- `direction` (String) The direction used to sort returned rules.
+- `direction` (String) Defines the direction used to sort returned rules.
 Available values: "asc", "desc".
-- `match` (String) When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
+- `match` (String) Defines the search requirements. When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
 Available values: "any", "all".
 - `max_items` (Number) Max items to fetch, default: 1000
 - `mode` (String) The action to apply to a matched request.
 Available values: "block", "challenge", "whitelist", "js_challenge", "managed_challenge".
-- `notes` (String) The string to search for in the notes of existing IP Access rules.
+- `notes` (String) Defines the string to search for in the notes of existing IP Access rules.
 Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
-- `order` (String) The field used to sort returned rules.
+- `order` (String) Defines the field used to sort returned rules.
 Available values: "configuration.target", "configuration.value", "mode".
 - `zone_id` (String) The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
 
@@ -55,9 +55,9 @@ Available values: "configuration.target", "configuration.value", "mode".
 
 Optional:
 
-- `target` (String) The target to search in existing rules.
+- `target` (String) Defines the target to search in existing rules.
 Available values: "ip", "ip_range", "asn", "country".
-- `value` (String) The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
+- `value` (String) Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
 Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
 
 
@@ -92,8 +92,8 @@ Available values: "ip".
 Read-Only:
 
 - `email` (String) The contact email address of the user.
-- `id` (String) Identifier
-- `type` (String) The scope of the rule.
+- `id` (String) Defines an identifier.
+- `type` (String) Defines the scope of the rule.
 Available values: "user", "organization".
 
 

docs/data-sources/access_rules.md

@@ -22,7 +22,7 @@ data "cloudflare_account_dns_settings" "example_account_dns_settings" {
 
 ### Required
 
-- `account_id` (String) Identifier
+- `account_id` (String) Identifier.
 
 ### Read-Only
 

docs/data-sources/account_dns_settings.md

@@ -23,17 +23,17 @@ data "cloudflare_account_dns_settings_internal_view" "example_account_dns_settin
 
 ### Required
 
-- `account_id` (String) Identifier
+- `account_id` (String) Identifier.
 
 ### Optional
 
 - `filter` (Attributes) (see [below for nested schema](#nestedatt--filter))
-- `view_id` (String) Identifier
+- `view_id` (String) Identifier.
 
 ### Read-Only
 
 - `created_time` (String) When the view was created.
-- `id` (String) Identifier
+- `id` (String) Identifier.
 - `modified_time` (String) When the view was last modified.
 - `name` (String) The name of the view.
 - `zones` (List of String) The list of zones linked to this view.

docs/data-sources/account_dns_settings_internal_view.md

@@ -31,7 +31,7 @@ data "cloudflare_account_dns_settings_internal_views" "example_account_dns_setti
 
 ### Required
 
-- `account_id` (String) Identifier
+- `account_id` (String) Identifier.
 
 ### Optional
 
@@ -67,7 +67,7 @@ Optional:
 Read-Only:
 
 - `created_time` (String) When the view was created.
-- `id` (String) Identifier
+- `id` (String) Identifier.
 - `modified_time` (String) When the view was last modified.
 - `name` (String) The name of the view.
 - `zones` (List of String) The list of zones linked to this view.