Metadata-Version: 2.1
Name: pulumi-cloudflare
Version: 4.11.0a1663281018
Summary: A Pulumi package for creating and managing Cloudflare cloud resources.
Home-page: https://pulumi.io
License: Apache-2.0
Project-URL: Repository, https://github.com/pulumi/pulumi-cloudflare
Keywords: pulumi cloudflare
Platform: UNKNOWN
Description-Content-Type: text/markdown

[![Actions Status](https://github.com/pulumi/pulumi-cloudflare/workflows/master/badge.svg)](https://github.com/pulumi/pulumi-cloudflare/actions)
[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com)
[![NPM version](https://badge.fury.io/js/%40pulumi%2Fcloudflare.svg)](https://www.npmjs.com/package/@pulumi/cloudflare)
[![Python version](https://badge.fury.io/py/pulumi-cloudflare.svg)](https://pypi.org/project/pulumi-cloudflare)
[![NuGet version](https://badge.fury.io/nu/pulumi.cloudflare.svg)](https://badge.fury.io/nu/pulumi.cloudflare)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/pulumi/pulumi-cloudflare/sdk/v3/go)](https://pkg.go.dev/github.com/pulumi/pulumi-cloudflare/sdk/v3/go)
[![License](https://img.shields.io/npm/l/%40pulumi%2Fpulumi.svg)](https://github.com/pulumi/pulumi-cloudflare/blob/master/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](https://pulumi.io/).

## 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/v3

### .NET

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

    $ dotnet add package Pulumi.Cloudflare

## Configuration

The following configuration points are available:

- `cloudflare:email` - (Optional) The email associated with the account. May be set via the `CLOUDFLARE_EMAIL` environment variable.
- `cloudflare:apiKey` - (Optional) The Cloudflare API key. May be set via the `CLOUDFLARE_API_KEY` environment variable. 
- `cloudflare:apiToken` - (Optional) The Cloudflare API Token. May be set via the `CLOUDFLARE_API_TOKEN` environment variable. This is an alternative to `email` + `apiKey`. If both are specified, `apiToken` will be used over `email` + `apiKey` fields
- `cloudflare:accountId` - (Optional) Configure API client with this account ID, so calls use the account API rather than the (default) user API. This is required for other users in your account to have access to the resources you manage. May be set via the `CLOUDFLARE_ACCOUNT_ID` 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: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:minBackoff` - (Optional) Minimum backoff period in seconds after failed API calls. Default: `1`. May be set via the `CLOUDFLARE_MIN_BACKOFF` environment variable.
- `cloudflare:minBackoff` - (Optional) Maximum backoff period in seconds after failed API calls. Default: `30`. May be set via the `CLOUDFLARE_MAX_BACKOFF` environment variable.
- `cloudflare:apiClientLogging` - (Optional) Whether to print logs from the API client (using the default log library logger). Default: `false`. May be set via the `CLOUDFLARE_API_CLIENT_LOGGING` environment variable.
- `cloudflare:apiUserServiceKey` - (Optional) The Cloudflare API User Service Key. This is used for a specific set of endpoints, such as creating Origin CA certificates. May be set via the `CLOUDFLARE_API_USER_SERVICE_KEY` environment variable.

## Reference

For further information, please visit [the Cloudflare provider docs](https://www.pulumi.com/docs/intro/cloud-providers/cloudflare) or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/cloudflare).


