| Name | pulumi-cloudflare JSON |
| Version |
5.33.0
JSON |
| download |
| home_page | None |
| Summary | A Pulumi package for creating and managing Cloudflare cloud resources. |
| upload_time | 2024-06-26 06:40:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
pulumi
cloudflare
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/pulumi/pulumi-cloudflare/actions)
[](https://slack.pulumi.com)
[](https://www.npmjs.com/package/@pulumi/cloudflare)
[](https://pypi.org/project/pulumi-cloudflare)
[](https://badge.fury.io/nu/pulumi.cloudflare)
[](https://pkg.go.dev/github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare)
[](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/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](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).
Raw data
{
"_id": null,
"home_page": null,
"name": "pulumi-cloudflare",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pulumi, cloudflare",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/3f/1a13364eeaff32b770f704cbec36d32f796094b477a48a6b95f59230b5f0/pulumi_cloudflare-5.33.0.tar.gz",
"platform": null,
"description": "[](https://github.com/pulumi/pulumi-cloudflare/actions)\n[](https://slack.pulumi.com)\n[](https://www.npmjs.com/package/@pulumi/cloudflare)\n[](https://pypi.org/project/pulumi-cloudflare)\n[](https://badge.fury.io/nu/pulumi.cloudflare)\n[](https://pkg.go.dev/github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare)\n[](https://github.com/pulumi/pulumi-cloudflare/blob/master/LICENSE)\n\n# Cloudflare Provider\n\nThe Cloudflare resource provider for Pulumi lets you use Cloudflare resources\nin your cloud programs. To use this package, please [install the Pulumi CLI\nfirst](https://pulumi.io/).\n\n## Installing\n\nThis package is available in many languages in the standard packaging formats.\n\n### Node.js (Java/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n $ npm install @pulumi/cloudflare\n\nor `yarn`:\n\n $ yarn add @pulumi/cloudflare\n\n### Python\n\nTo use from Python, install using `pip`:\n\n $ pip install pulumi_cloudflare\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library\n\n $ go get github.com/pulumi/pulumi-cloudflare/sdk/v5\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n $ dotnet add package Pulumi.Cloudflare\n\n## Configuration\n\nThe following configuration points are available:\n\n- `cloudflare:apiBasePath` - (Optional) Configure the base path used by the API client. Alternatively, can be configured using the `CLOUDFLARE_API_BASE_PATH` environment variable.\n- `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.\n- `cloudflare:apiHostname` - (Optional) Configure the hostname used by the API client. Alternatively, can be configured using the `CLOUDFLARE_API_HOSTNAME` environment variable.\n- `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`.\n- `cloudflare:apiKey` - (Optional) The Cloudflare API key. May be set via the `CLOUDFLARE_API_KEY` environment variable. \n- `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`.\n- `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`.\n- `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`.\n- `cloudflare:maxBackoff` - (Optional) Maximum backoff period in seconds after failed API calls. Default: `30`. May be set via the `CLOUDFLARE_MAX_BACKOFF` environment variable.\n- `cloudflare:minBackoff` - (Optional) Minimum backoff period in seconds after failed API calls. Default: `1`. May be set via the `CLOUDFLARE_MIN_BACKOFF` environment variable.\n- `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.\n- `cloudflare:rps` - (Optional) RPS limit to apply when making calls to the API. Default: `4`. May be set via the `CLOUDFLARE_RPS` environment variable.\n- `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.\n\n## Reference\n\nFor 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).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing Cloudflare cloud resources.",
"version": "5.33.0",
"project_urls": {
"Homepage": "https://pulumi.io",
"Repository": "https://github.com/pulumi/pulumi-cloudflare"
},
"split_keywords": [
"pulumi",
" cloudflare"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "509aea2353815e6d3391d69693862821684c675105c6b01baf84066f58afc65c",
"md5": "9b36dad00e593247c98b53e89583c3eb",
"sha256": "7e99817a442eb48d2ae8aa44d0d751b3008fc6d5b02e7b61dcf693c8ee09eea5"
},
"downloads": -1,
"filename": "pulumi_cloudflare-5.33.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b36dad00e593247c98b53e89583c3eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 560137,
"upload_time": "2024-06-26T06:40:23",
"upload_time_iso_8601": "2024-06-26T06:40:23.593098Z",
"url": "https://files.pythonhosted.org/packages/50/9a/ea2353815e6d3391d69693862821684c675105c6b01baf84066f58afc65c/pulumi_cloudflare-5.33.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "723f1a13364eeaff32b770f704cbec36d32f796094b477a48a6b95f59230b5f0",
"md5": "8a6d4ea397c4afb5eca95f83e4ca4467",
"sha256": "347938da8a3a5762852152039f74d4f7a1d59b5e92d0d7efa4d2b69d921ab41a"
},
"downloads": -1,
"filename": "pulumi_cloudflare-5.33.0.tar.gz",
"has_sig": false,
"md5_digest": "8a6d4ea397c4afb5eca95f83e4ca4467",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 383674,
"upload_time": "2024-06-26T06:40:29",
"upload_time_iso_8601": "2024-06-26T06:40:29.357207Z",
"url": "https://files.pythonhosted.org/packages/72/3f/1a13364eeaff32b770f704cbec36d32f796094b477a48a6b95f59230b5f0/pulumi_cloudflare-5.33.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 06:40:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pulumi",
"github_project": "pulumi-cloudflare",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-cloudflare"
}
