cloudflare.Provider
Explore with Pulumi AI
The provider type for the cloudflare package. By default, resources use package-wide configuration
settings, however an explicit Provider
instance may be created and passed during resource
construction to achieve fine-grained programmatic control over provider settings. See the
documentation for more information.
Create Provider Resource
new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_base_path: Optional[str] = None,
api_client_logging: Optional[bool] = None,
api_hostname: Optional[str] = None,
api_key: Optional[str] = None,
api_token: Optional[str] = None,
api_user_service_key: Optional[str] = None,
email: Optional[str] = None,
max_backoff: Optional[int] = None,
min_backoff: Optional[int] = None,
retries: Optional[int] = None,
rps: Optional[int] = None,
user_agent_operator_suffix: Optional[str] = None)
@overload
def Provider(resource_name: str,
args: Optional[ProviderArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:cloudflare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Provider Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Provider resource accepts the following input properties:
- Api
Base stringPath Configure the base path used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_BASE_PATH
environment variable.- Api
Client boolLogging 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. It can also be sourced from the following environment variable:CLOUDFLARE_API_CLIENT_LOGGING
- Api
Hostname string Configure the hostname used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_HOSTNAME
environment variable.- Api
Key string 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 ofapi_key
,api_token
,api_user_service_key
.- Api
Token string The API Token for operations. Alternatively, can be configured using the
CLOUDFLARE_API_TOKEN
environment variable. Must provide only one ofapi_key
,api_token
,api_user_service_key
.- Api
User stringService Key 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 ofapi_key
,api_token
,api_user_service_key
.- Email string
A registered Cloudflare email address. Alternatively, can be configured using the
CLOUDFLARE_EMAIL
environment variable. Required when usingapi_key
. Conflicts withapi_token
.- Max
Backoff int Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MAX_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MAX_BACKOFF
- Min
Backoff int Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MIN_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MIN_BACKOFF
- Retries int
Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the
CLOUDFLARE_RETRIES
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RETRIES
- Rps int
RPS limit to apply when making calls to the API. Alternatively, can be configured using the
CLOUDFLARE_RPS
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RPS
- User
Agent stringOperator Suffix 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 Terraform 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.
- Api
Base stringPath Configure the base path used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_BASE_PATH
environment variable.- Api
Client boolLogging 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. It can also be sourced from the following environment variable:CLOUDFLARE_API_CLIENT_LOGGING
- Api
Hostname string Configure the hostname used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_HOSTNAME
environment variable.- Api
Key string 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 ofapi_key
,api_token
,api_user_service_key
.- Api
Token string The API Token for operations. Alternatively, can be configured using the
CLOUDFLARE_API_TOKEN
environment variable. Must provide only one ofapi_key
,api_token
,api_user_service_key
.- Api
User stringService Key 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 ofapi_key
,api_token
,api_user_service_key
.- Email string
A registered Cloudflare email address. Alternatively, can be configured using the
CLOUDFLARE_EMAIL
environment variable. Required when usingapi_key
. Conflicts withapi_token
.- Max
Backoff int Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MAX_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MAX_BACKOFF
- Min
Backoff int Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MIN_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MIN_BACKOFF
- Retries int
Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the
CLOUDFLARE_RETRIES
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RETRIES
- Rps int
RPS limit to apply when making calls to the API. Alternatively, can be configured using the
CLOUDFLARE_RPS
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RPS
- User
Agent stringOperator Suffix 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 Terraform 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.
- api
Base StringPath Configure the base path used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_BASE_PATH
environment variable.- api
Client BooleanLogging 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. It can also be sourced from the following environment variable:CLOUDFLARE_API_CLIENT_LOGGING
- api
Hostname String Configure the hostname used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_HOSTNAME
environment variable.- api
Key String 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 ofapi_key
,api_token
,api_user_service_key
.- api
Token String The API Token for operations. Alternatively, can be configured using the
CLOUDFLARE_API_TOKEN
environment variable. Must provide only one ofapi_key
,api_token
,api_user_service_key
.- api
User StringService Key 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 ofapi_key
,api_token
,api_user_service_key
.- email String
A registered Cloudflare email address. Alternatively, can be configured using the
CLOUDFLARE_EMAIL
environment variable. Required when usingapi_key
. Conflicts withapi_token
.- max
Backoff Integer Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MAX_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MAX_BACKOFF
- min
Backoff Integer Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MIN_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MIN_BACKOFF
- retries Integer
Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the
CLOUDFLARE_RETRIES
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RETRIES
- rps Integer
RPS limit to apply when making calls to the API. Alternatively, can be configured using the
CLOUDFLARE_RPS
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RPS
- user
Agent StringOperator Suffix 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 Terraform 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.
- api
Base stringPath Configure the base path used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_BASE_PATH
environment variable.- api
Client booleanLogging 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. It can also be sourced from the following environment variable:CLOUDFLARE_API_CLIENT_LOGGING
- api
Hostname string Configure the hostname used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_HOSTNAME
environment variable.- api
Key string 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 ofapi_key
,api_token
,api_user_service_key
.- api
Token string The API Token for operations. Alternatively, can be configured using the
CLOUDFLARE_API_TOKEN
environment variable. Must provide only one ofapi_key
,api_token
,api_user_service_key
.- api
User stringService Key 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 ofapi_key
,api_token
,api_user_service_key
.- email string
A registered Cloudflare email address. Alternatively, can be configured using the
CLOUDFLARE_EMAIL
environment variable. Required when usingapi_key
. Conflicts withapi_token
.- max
Backoff number Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MAX_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MAX_BACKOFF
- min
Backoff number Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MIN_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MIN_BACKOFF
- retries number
Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the
CLOUDFLARE_RETRIES
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RETRIES
- rps number
RPS limit to apply when making calls to the API. Alternatively, can be configured using the
CLOUDFLARE_RPS
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RPS
- user
Agent stringOperator Suffix 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 Terraform 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.
- api_
base_ strpath Configure the base path used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_BASE_PATH
environment variable.- api_
client_ boollogging 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. It can also be sourced from the following environment variable:CLOUDFLARE_API_CLIENT_LOGGING
- api_
hostname str Configure the hostname used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_HOSTNAME
environment variable.- api_
key str 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 ofapi_key
,api_token
,api_user_service_key
.- api_
token str The API Token for operations. Alternatively, can be configured using the
CLOUDFLARE_API_TOKEN
environment variable. Must provide only one ofapi_key
,api_token
,api_user_service_key
.- api_
user_ strservice_ key 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 ofapi_key
,api_token
,api_user_service_key
.- email str
A registered Cloudflare email address. Alternatively, can be configured using the
CLOUDFLARE_EMAIL
environment variable. Required when usingapi_key
. Conflicts withapi_token
.- max_
backoff int Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MAX_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MAX_BACKOFF
- min_
backoff int Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MIN_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MIN_BACKOFF
- retries int
Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the
CLOUDFLARE_RETRIES
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RETRIES
- rps int
RPS limit to apply when making calls to the API. Alternatively, can be configured using the
CLOUDFLARE_RPS
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RPS
- user_
agent_ stroperator_ suffix 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 Terraform 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.
- api
Base StringPath Configure the base path used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_BASE_PATH
environment variable.- api
Client BooleanLogging 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. It can also be sourced from the following environment variable:CLOUDFLARE_API_CLIENT_LOGGING
- api
Hostname String Configure the hostname used by the API client. Alternatively, can be configured using the
CLOUDFLARE_API_HOSTNAME
environment variable.- api
Key String 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 ofapi_key
,api_token
,api_user_service_key
.- api
Token String The API Token for operations. Alternatively, can be configured using the
CLOUDFLARE_API_TOKEN
environment variable. Must provide only one ofapi_key
,api_token
,api_user_service_key
.- api
User StringService Key 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 ofapi_key
,api_token
,api_user_service_key
.- email String
A registered Cloudflare email address. Alternatively, can be configured using the
CLOUDFLARE_EMAIL
environment variable. Required when usingapi_key
. Conflicts withapi_token
.- max
Backoff Number Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MAX_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MAX_BACKOFF
- min
Backoff Number Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the
CLOUDFLARE_MIN_BACKOFF
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_MIN_BACKOFF
- retries Number
Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the
CLOUDFLARE_RETRIES
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RETRIES
- rps Number
RPS limit to apply when making calls to the API. Alternatively, can be configured using the
CLOUDFLARE_RPS
environment variable. It can also be sourced from the following environment variable:CLOUDFLARE_RPS
- user
Agent StringOperator Suffix 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 Terraform 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cloudflare
Terraform Provider.