Skip to main content

A Pulumi package for creating and managing Cloudflare cloud resources.

Project description

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/v6

.NET

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

$ dotnet add package Pulumi.Cloudflare

Configuration

The following configuration points are available:

  • 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: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:baseUrl (String) Value to override the default HTTP client base URL. Alternatively, can be configured using the CLOUDFLARE_BASE_URL environment variable.
  • 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: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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_cloudflare-6.3.1.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

pulumi_cloudflare-6.3.1-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file pulumi_cloudflare-6.3.1.tar.gz.

File metadata

  • Download URL: pulumi_cloudflare-6.3.1.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for pulumi_cloudflare-6.3.1.tar.gz
Algorithm Hash digest
SHA256 1935b6aede84cb7173929809dd6b8775371c6df6650745c42d3970fe731e3db4
MD5 c9cafeedce8ad26fe6513df0b5d0a8ec
BLAKE2b-256 5f1122e63f3baaaf4daf375c409ce166a71a1e29a5e0bca06f6fa67321de3ab5

See more details on using hashes here.

File details

Details for the file pulumi_cloudflare-6.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_cloudflare-6.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 76683e3437620079d94396452cc7098c953dfc79a0d83f7d45f474357702a7a6
MD5 d1c5e8f22eea70c1f24f93837bb2d924
BLAKE2b-256 c8b2f2393070b772d9d6fac79d317e242fbe7c0be0578496b9d21a7f7ec6dedf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page