Package: pulumi-cloudflare
Cloudflare ProviderThe Cloudflare resource provider for Pulumi lets you use Cloudflare resources
in your cloud programs. To use this package, pleaseinstall the Pulumi CLI
first.InstallingThis 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 eithernpm:$ npm install @pulumi/cloudflareoryarn:$ yarn add @pulumi/cloudflarePythonTo use from Python, install usingpip:$ pip install pulumi_cloudflareGoTo use from Go, usego getto grab the latest version of the library$ go get github.com/pulumi/pulumi-cloudflare/sdk/v5.NETTo use from .NET, install usingdotnet add package:$ dotnet add package Pulumi.CloudflareConfigurationThe following configuration points are available:cloudflare:apiBasePath- (Optional) Configure the base path used by the API client. Alternatively, can be configured using theCLOUDFLARE_API_BASE_PATHenvironment variable.cloudflare:apiClientLogging- (Optional) Whether to print logs from the API client (using the default log library logger). Alternatively, can be configured using theCLOUDFLARE_API_CLIENT_LOGGINGenvironment variable.cloudflare:apiHostname- (Optional) Configure the hostname used by the API client. Alternatively, can be configured using theCLOUDFLARE_API_HOSTNAMEenvironment variable.cloudflare:apiKey- (Optional) The API key for operations. Alternatively, can be configured using theCLOUDFLARE_API_KEYenvironment variable. API keys are now considered legacy by Cloudflare, API tokens should be used instead. Must provide only one ofcloudflare:apiKey,cloudflare:apiToken,cloudflare:apiUserServiceKey.cloudflare:apiKey- (Optional) The Cloudflare API key. May be set via theCLOUDFLARE_API_KEYenvironment variable.cloudflare:apiToken- (Optional) The API Token for operations. Alternatively, can be configured using theCLOUDFLARE_API_TOKENenvironment variable. Must provide only one ofcloudflare: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 theCLOUDFLARE_API_USER_SERVICE_KEYenvironment variable. Must provide only one ofcloudflare:apiKey,cloudflare:apiToken,cloudflare:apiUserServiceKey.cloudflare:email- (Optional) A registered Cloudflare email address. Alternatively, can be configured using theCLOUDFLARE_EMAILenvironment variable. Required when usingcloudflare:apiKey. Conflicts withcloudflare:apiToken.cloudflare:maxBackoff- (Optional) Maximum backoff period in seconds after failed API calls. Default:30. May be set via theCLOUDFLARE_MAX_BACKOFFenvironment variable.cloudflare:minBackoff- (Optional) Minimum backoff period in seconds after failed API calls. Default:1. May be set via theCLOUDFLARE_MIN_BACKOFFenvironment variable.cloudflare:retries- (Optional) Maximum number of retries to perform when an API request fails. Default:3. May be set via theCLOUDFLARE_RETRIESenvironment variable.cloudflare:rps- (Optional) RPS limit to apply when making calls to the API. Default:4. May be set via theCLOUDFLARE_RPSenvironment 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 theCLOUDFLARE_USER_AGENT_OPERATOR_SUFFIXenvironment variable.ReferenceFor further information, please visitthe Cloudflare provider docsor for detailed reference documentation, please visitthe API docs.