1. Docs
  2. Reference
  3. API
  4. Cloudflare
  5. Provider

Provider

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 a Provider Resource

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
def Provider(resource_name, opts=None, account_id=None, api_client_logging=None, api_key=None, api_token=None, api_user_service_key=None, email=None, max_backoff=None, min_backoff=None, retries=None, rps=None, __props__=None);
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

AccountId string

Configure API client to always use that account.

ApiClientLogging bool

Whether to print logs from the API client (using the default log library logger)

ApiKey string

The API key for operations.

ApiToken string

The API Token for operations.

ApiUserServiceKey string

A special Cloudflare API key good for a restricted set of endpoints.

Email string

A registered Cloudflare email address.

MaxBackoff int

Maximum backoff period in seconds after failed API calls

MinBackoff int

Minimum backoff period in seconds after failed API calls

Retries int

Maximum number of retries to perform when an API request fails

Rps int

RPS limit to apply when making calls to the API

AccountId string

Configure API client to always use that account.

ApiClientLogging bool

Whether to print logs from the API client (using the default log library logger)

ApiKey string

The API key for operations.

ApiToken string

The API Token for operations.

ApiUserServiceKey string

A special Cloudflare API key good for a restricted set of endpoints.

Email string

A registered Cloudflare email address.

MaxBackoff int

Maximum backoff period in seconds after failed API calls

MinBackoff int

Minimum backoff period in seconds after failed API calls

Retries int

Maximum number of retries to perform when an API request fails

Rps int

RPS limit to apply when making calls to the API

accountId string

Configure API client to always use that account.

apiClientLogging boolean

Whether to print logs from the API client (using the default log library logger)

apiKey string

The API key for operations.

apiToken string

The API Token for operations.

apiUserServiceKey string

A special Cloudflare API key good for a restricted set of endpoints.

email string

A registered Cloudflare email address.

maxBackoff number

Maximum backoff period in seconds after failed API calls

minBackoff number

Minimum backoff period in seconds after failed API calls

retries number

Maximum number of retries to perform when an API request fails

rps number

RPS limit to apply when making calls to the API

account_id str

Configure API client to always use that account.

api_client_logging bool

Whether to print logs from the API client (using the default log library logger)

api_key str

The API key for operations.

api_token str

The API Token for operations.

api_user_service_key str

A special Cloudflare API key good for a restricted set of endpoints.

email str

A registered Cloudflare email address.

max_backoff float

Maximum backoff period in seconds after failed API calls

min_backoff float

Minimum backoff period in seconds after failed API calls

retries float

Maximum number of retries to perform when an API request fails

rps float

RPS limit to apply when making calls to the API

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 str
The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.