provider

README

provider

Refer to the Terraform Registory for docs: cloudflare.

Documentation

Index

• func CloudflareProvider_IsConstruct(x interface{}) *bool
• func CloudflareProvider_TfResourceType() *string
• func NewCloudflareProvider_Override(c CloudflareProvider, scope constructs.Construct, id *string, ...)
• type CloudflareProvider
  • func NewCloudflareProvider(scope constructs.Construct, id *string, config *CloudflareProviderConfig) CloudflareProvider
• type CloudflareProviderConfig

Functions

func CloudflareProvider_IsConstruct

func CloudflareProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func CloudflareProvider_TfResourceType

func CloudflareProvider_TfResourceType() *string

func NewCloudflareProvider_Override

func NewCloudflareProvider_Override(c CloudflareProvider, scope constructs.Construct, id *string, config *CloudflareProviderConfig)

Create a new {@link https://www.terraform.io/docs/providers/cloudflare cloudflare} Resource.

Types

type CloudflareProvider

type CloudflareProvider interface {
	cdktf.TerraformProvider
	AccountId() *string
	SetAccountId(val *string)
	AccountIdInput() *string
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	ApiBasePath() *string
	SetApiBasePath(val *string)
	ApiBasePathInput() *string
	ApiClientLogging() interface{}
	SetApiClientLogging(val interface{})
	ApiClientLoggingInput() interface{}
	ApiHostname() *string
	SetApiHostname(val *string)
	ApiHostnameInput() *string
	ApiKey() *string
	SetApiKey(val *string)
	ApiKeyInput() *string
	ApiToken() *string
	SetApiToken(val *string)
	ApiTokenInput() *string
	ApiUserServiceKey() *string
	SetApiUserServiceKey(val *string)
	ApiUserServiceKeyInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	Email() *string
	SetEmail(val *string)
	EmailInput() *string
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	MaxBackoff() *float64
	SetMaxBackoff(val *float64)
	MaxBackoffInput() *float64
	// Experimental.
	MetaAttributes() *map[string]interface{}
	MinBackoff() *float64
	SetMinBackoff(val *float64)
	MinBackoffInput() *float64
	// The tree node.
	Node() constructs.Node
	// Experimental.
	RawOverrides() interface{}
	Retries() *float64
	SetRetries(val *float64)
	RetriesInput() *float64
	Rps() *float64
	SetRps(val *float64)
	RpsInput() *float64
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccountId()
	ResetAlias()
	ResetApiBasePath()
	ResetApiClientLogging()
	ResetApiHostname()
	ResetApiKey()
	ResetApiToken()
	ResetApiUserServiceKey()
	ResetEmail()
	ResetMaxBackoff()
	ResetMinBackoff()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRetries()
	ResetRps()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://www.terraform.io/docs/providers/cloudflare cloudflare}.

func NewCloudflareProvider

func NewCloudflareProvider(scope constructs.Construct, id *string, config *CloudflareProviderConfig) CloudflareProvider

Create a new {@link https://www.terraform.io/docs/providers/cloudflare cloudflare} Resource.

type CloudflareProviderConfig

type CloudflareProviderConfig struct {
	// Configure API client to always use a specific account. Alternatively, can be configured using the `CLOUDFLARE_ACCOUNT_ID` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#account_id CloudflareProvider#account_id}
	AccountId *string `field:"optional" json:"accountId" yaml:"accountId"`
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#alias CloudflareProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// Configure the base path used by the API client. Alternatively, can be configured using the `CLOUDFLARE_API_BASE_PATH` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#api_base_path CloudflareProvider#api_base_path}
	ApiBasePath *string `field:"optional" json:"apiBasePath" yaml:"apiBasePath"`
	// 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.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#api_client_logging CloudflareProvider#api_client_logging}
	ApiClientLogging interface{} `field:"optional" json:"apiClientLogging" yaml:"apiClientLogging"`
	// Configure the hostname used by the API client. Alternatively, can be configured using the `CLOUDFLARE_API_HOSTNAME` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#api_hostname CloudflareProvider#api_hostname}
	ApiHostname *string `field:"optional" json:"apiHostname" yaml:"apiHostname"`
	// The API key for operations.
	//
	// Alternatively, can be configured using the `CLOUDFLARE_API_KEY` environment variable. API keys are [now considered legacy by Cloudflare](https://developers.cloudflare.com/api/keys/#limitations), API tokens should be used instead. Must provide only one of `api_key`, `api_token`, `api_user_service_key`.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#api_key CloudflareProvider#api_key}
	ApiKey *string `field:"optional" json:"apiKey" yaml:"apiKey"`
	// 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`.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#api_token CloudflareProvider#api_token}
	ApiToken *string `field:"optional" json:"apiToken" yaml:"apiToken"`
	// 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`.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#api_user_service_key CloudflareProvider#api_user_service_key}
	ApiUserServiceKey *string `field:"optional" json:"apiUserServiceKey" yaml:"apiUserServiceKey"`
	// A registered Cloudflare email address.
	//
	// Alternatively, can be configured using the `CLOUDFLARE_EMAIL` environment variable. Required when using `api_key`. Conflicts with `api_token`.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#email CloudflareProvider#email}
	Email *string `field:"optional" json:"email" yaml:"email"`
	// Maximum backoff period in seconds after failed API calls. Alternatively, can be configured using the `CLOUDFLARE_MAX_BACKOFF` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#max_backoff CloudflareProvider#max_backoff}
	MaxBackoff *float64 `field:"optional" json:"maxBackoff" yaml:"maxBackoff"`
	// Minimum backoff period in seconds after failed API calls. Alternatively, can be configured using the `CLOUDFLARE_MIN_BACKOFF` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#min_backoff CloudflareProvider#min_backoff}
	MinBackoff *float64 `field:"optional" json:"minBackoff" yaml:"minBackoff"`
	// Maximum number of retries to perform when an API request fails.
	//
	// Alternatively, can be configured using the `CLOUDFLARE_RETRIES` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#retries CloudflareProvider#retries}
	Retries *float64 `field:"optional" json:"retries" yaml:"retries"`
	// RPS limit to apply when making calls to the API. Alternatively, can be configured using the `CLOUDFLARE_RPS` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/cloudflare#rps CloudflareProvider#rps}
	Rps *float64 `field:"optional" json:"rps" yaml:"rps"`
}