Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Actions Status Slack NPM version Python version NuGet version PkgGoDev License

Cloudflare Provider

The Cloudflare resource provider for Pulumi lets you use Cloudflare resources in your cloud programs. To use this package, please install the Pulumi CLI first.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @pulumi/cloudflare

or yarn:

$ yarn add @pulumi/cloudflare

Python

To use from Python, install using pip:

$ pip install pulumi_cloudflare

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/pulumi/pulumi-cloudflare/sdk/v5

.NET

To use from .NET, install using dotnet add package:

$ dotnet add package Pulumi.Cloudflare

Configuration

The following configuration points are available:

  • cloudflare:apiBasePath - (Optional) Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
  • cloudflare:apiClientLogging - (Optional) Whether to print logs from the API client (using the default log library logger). Alternatively, can be configured using the CLOUDFLARE_API_CLIENT_LOGGING environment variable.
  • cloudflare:apiHostname - (Optional) Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.
  • cloudflare:apiKey - (Optional) The API key for operations. Alternatively, can be configured using the CLOUDFLARE_API_KEY environment variable. API keys are now considered legacy by Cloudflare, API tokens should be used instead. Must provide only one of cloudflare:apiKey, cloudflare:apiToken, cloudflare:apiUserServiceKey.
  • cloudflare:apiKey - (Optional) The Cloudflare API key. May be set via the CLOUDFLARE_API_KEY environment variable.
  • cloudflare:apiToken - (Optional) The API Token for operations. Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of cloudflare:apiKey, cloudflare:apiToken, cloudflare:apiUserServiceKey.
  • cloudflare:apiUserServiceKey - (Optional) A special Cloudflare API key good for a restricted set of endpoints. Alternatively, can be configured using the CLOUDFLARE_API_USER_SERVICE_KEY environment variable. Must provide only one of cloudflare:apiKey, cloudflare:apiToken, cloudflare:apiUserServiceKey.
  • cloudflare:email - (Optional) A registered Cloudflare email address. Alternatively, can be configured using the CLOUDFLARE_EMAIL environment variable. Required when using cloudflare:apiKey. Conflicts with cloudflare:apiToken.
  • cloudflare:maxBackoff - (Optional) Maximum backoff period in seconds after failed API calls. Default: 30. May be set via the CLOUDFLARE_MAX_BACKOFF environment variable.
  • cloudflare:minBackoff - (Optional) Minimum backoff period in seconds after failed API calls. Default: 1. May be set via the CLOUDFLARE_MIN_BACKOFF environment variable.
  • cloudflare:retries - (Optional) Maximum number of retries to perform when an API request fails. Default: 3. May be set via the CLOUDFLARE_RETRIES environment variable.
  • cloudflare:rps - (Optional) RPS limit to apply when making calls to the API. Default: 4. May be set via the CLOUDFLARE_RPS environment variable.
  • cloudflare:userAgentOperatorSuffix - (Optional) A value to append to the HTTP User Agent for all API calls. This value is not something most users need to modify however, if you are using a non-standard provider or operator configuration, this is recommended to assist in uniquely identifying your traffic. Setting this value will remove the Pulumi version from the HTTP User Agent string and may have unintended consequences. Alternatively, can be configured using the CLOUDFLARE_USER_AGENT_OPERATOR_SUFFIX environment variable.

Reference

For further information, please visit the Cloudflare provider docs or for detailed reference documentation, please visit the API docs.

Metadata

Release files for pulumi-cloudflare 5.43.0a1730870541

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pulumi-cloudflare 5.43.0a1730870541
File Size Uploaded Provenance Actions
pulumi_cloudflare-5.43.0a1730870541.tar.gz 584.1 kB Without provenance Details for pulumi_cloudflare-5.43.0a1730870541.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pulumi-cloudflare 5.43.0a1730870541
File Interpreter ABI Platform Actions
pulumi_cloudflare-5.43.0a1730870541-py3-none-any.whl Python 3 none any Details for pulumi_cloudflare-5.43.0a1730870541-py3-none-any.whl

Total release size: 1.4 MB

Release files / pulumi_cloudflare-5.43.0a1730870541.tar.gz

Download URL pulumi_cloudflare-5.43.0a1730870541.tar.gz
Size 584.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f275ae3bf02a39a873d5f9d41ce9dd16693d650915ed503f36d2b36bfdebd365
BLAKE2b-256 checksum
How to use checksums
2540432b6755ca1a04f9d2389179217092fa2004a7252d4894a1a5dff37cab57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.8

Release files / pulumi_cloudflare-5.43.0a1730870541-py3-none-any.whl

Download URL pulumi_cloudflare-5.43.0a1730870541-py3-none-any.whl
Size 841.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab4aced0a4238e31dd58511b67484dcba352091ef4abc4f0d92f23fac611981e
BLAKE2b-256 checksum
How to use checksums
05a18c1e9352dac43066fdb06cb2fc779bd10b256ea3f5d845d4768772500e7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.8

Security for pulumi-cloudflare 5.43.0a1730870541

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page