pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/ProviderArgs

ProviderArgs

data class ProviderArgs(val apiBasePath: Output<String>? = null, val apiClientLogging: Output<Boolean>? = null, val apiHostname: Output<String>? = null, val apiKey: Output<String>? = null, val apiToken: Output<String>? = null, val apiUserServiceKey: Output<String>? = null, val email: Output<String>? = null, val maxBackoff: Output<Int>? = null, val minBackoff: Output<Int>? = null, val retries: Output<Int>? = null, val rps: Output<Int>? = null, val userAgentOperatorSuffix: Output<String>? = null) : ConvertibleToJava<ProviderArgs>

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.

Constructors

ProviderArgs

constructor(apiBasePath: Output<String>? = null, apiClientLogging: Output<Boolean>? = null, apiHostname: Output<String>? = null, apiKey: Output<String>? = null, apiToken: Output<String>? = null, apiUserServiceKey: Output<String>? = null, email: Output<String>? = null, maxBackoff: Output<Int>? = null, minBackoff: Output<Int>? = null, retries: Output<Int>? = null, rps: Output<Int>? = null, userAgentOperatorSuffix: Output<String>? = null)

Properties

apiBasePath

val apiBasePath: Output<String>? = null

Configure the base path used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_BASE_PATH environment variable.

apiClientLogging

val apiClientLogging: Output<Boolean>? = null

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.

apiHostname

val apiHostname: Output<String>? = null

Configure the hostname used by the API client. Alternatively, can be configured using the CLOUDFLARE_API_HOSTNAME environment variable.

apiKey

val apiKey: Output<String>? = null

The API key for operations. Alternatively, can be configured using the CLOUDFLARE_API_KEY environment variable. API keys are [now considered legacy by

apiToken

val apiToken: Output<String>? = null

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

val apiUserServiceKey: Output<String>? = null

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.

val email: Output<String>? = null

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

val maxBackoff: Output<Int>? = null

Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the CLOUDFLARE_MAX_BACKOFF environment variable.

minBackoff

val minBackoff: Output<Int>? = null

Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the CLOUDFLARE_MIN_BACKOFF environment variable.

retries

val retries: Output<Int>? = null

Maximum number of retries to perform when an API request fails. Alternatively, can be configured using the CLOUDFLARE_RETRIES environment variable.

rps

val rps: Output<Int>? = null

RPS limit to apply when making calls to the API. Alternatively, can be configured using the CLOUDFLARE_RPS environment variable.

userAgentOperatorSuffix

val userAgentOperatorSuffix: Output<String>? = null

Functions

toJava

open override fun toJava(): ProviderArgs