Docs Packages
  1. Packages
  2. Cloudflare
  3. API Docs
  4. Provider
Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.Provider

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-cloudflare

    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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@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)
    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.

    Parameters

    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:

    ApiBasePath string
    Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
    ApiClientLogging bool
    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
    ApiHostname string
    Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.
    ApiKey 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 of api_key, api_token, api_user_service_key.
    ApiToken string
    The API Token for operations. Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.
    ApiUserServiceKey string
    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 api_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 using api_key. Conflicts with api_token.
    MaxBackoff 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
    MinBackoff 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
    UserAgentOperatorSuffix string
    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.
    ApiBasePath string
    Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
    ApiClientLogging bool
    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
    ApiHostname string
    Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.
    ApiKey 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 of api_key, api_token, api_user_service_key.
    ApiToken string
    The API Token for operations. Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.
    ApiUserServiceKey string
    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 api_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 using api_key. Conflicts with api_token.
    MaxBackoff 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
    MinBackoff 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
    UserAgentOperatorSuffix string
    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.
    apiBasePath String
    Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
    apiClientLogging Boolean
    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
    apiHostname String
    Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.
    apiKey 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 of api_key, api_token, api_user_service_key.
    apiToken String
    The API Token for operations. Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.
    apiUserServiceKey String
    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 api_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 using api_key. Conflicts with api_token.
    maxBackoff 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
    minBackoff 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
    userAgentOperatorSuffix String
    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.
    apiBasePath string
    Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
    apiClientLogging boolean
    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
    apiHostname string
    Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.
    apiKey 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 of api_key, api_token, api_user_service_key.
    apiToken string
    The API Token for operations. Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.
    apiUserServiceKey string
    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 api_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 using api_key. Conflicts with api_token.
    maxBackoff 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
    minBackoff 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
    userAgentOperatorSuffix string
    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_path str
    Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
    api_client_logging bool
    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 of api_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 of api_key, api_token, api_user_service_key.
    api_user_service_key str
    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 api_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 using api_key. Conflicts with api_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_operator_suffix str
    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.
    apiBasePath String
    Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.
    apiClientLogging Boolean
    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
    apiHostname String
    Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.
    apiKey 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 of api_key, api_token, api_user_service_key.
    apiToken String
    The API Token for operations. Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.
    apiUserServiceKey String
    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 api_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 using api_key. Conflicts with api_token.
    maxBackoff 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
    minBackoff 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
    userAgentOperatorSuffix String
    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.
    cloudflare logo
    Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi
    pulumi/pulumi-cloudflare