`provider` Submodule

Constructs

CloudflareProvider

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

Initializers

from cdktn_provider_cloudflare import provider

provider.CloudflareProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  api_key: str = None,
  api_token: str = None,
  api_user_service_key: str = None,
  base_url: str = None,
  email: str = None,
  user_agent_operator_suffix: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`alias`	`str`	Alias name.
`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.
`base_url`	`str`	Value to override the default HTTP client base URL. Alternatively, can be configured using the `base_url` environment variable.
`email`	`str`	A registered Cloudflare email address.
`user_agent_operator_suffix`	`str`	A value to append to the HTTP User Agent for all API calls.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`alias`^Optional

Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#alias CloudflareProvider#alias}

`api_key`^Optional

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_key CloudflareProvider#api_key}

`api_token`^Optional

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_token CloudflareProvider#api_token}

`api_user_service_key`^Optional

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_user_service_key CloudflareProvider#api_user_service_key}

`base_url`^Optional

Type: str

Value to override the default HTTP client base URL. Alternatively, can be configured using the base_url environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#base_url CloudflareProvider#base_url}

`email`^Optional

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#email CloudflareProvider#email}

`user_agent_operator_suffix`^Optional

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#user_agent_operator_suffix CloudflareProvider#user_agent_operator_suffix}

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`reset_alias`	No description.
`reset_api_key`	No description.
`reset_api_token`	No description.
`reset_api_user_service_key`	No description.
`reset_base_url`	No description.
`reset_email`	No description.
`reset_user_agent_operator_suffix`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`reset_alias`

def reset_alias() -> None

`reset_api_key`

def reset_api_key() -> None

`reset_api_token`

def reset_api_token() -> None

`reset_api_user_service_key`

def reset_api_user_service_key() -> None

`reset_base_url`

def reset_base_url() -> None

`reset_email`

def reset_email() -> None

`reset_user_agent_operator_suffix`

def reset_user_agent_operator_suffix() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_provider`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a CloudflareProvider resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_cloudflare import provider

provider.CloudflareProvider.is_construct(
  x: typing.Any
)

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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_cloudflare import provider

provider.CloudflareProvider.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_provider`

from cdktn_provider_cloudflare import provider

provider.CloudflareProvider.is_terraform_provider(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_cloudflare import provider

provider.CloudflareProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a CloudflareProvider resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

The construct id used in the generated config for the CloudflareProvider to import.

`import_from_id`^Required

Type: str

The id of the existing CloudflareProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktn.TerraformProvider

? Optional instance of the provider where the CloudflareProvider to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`meta_attributes`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`terraform_provider_source`	`str`	No description.
`alias`	`str`	No description.
`alias_input`	`str`	No description.
`api_key_input`	`str`	No description.
`api_token_input`	`str`	No description.
`api_user_service_key_input`	`str`	No description.
`base_url_input`	`str`	No description.
`email_input`	`str`	No description.
`user_agent_operator_suffix_input`	`str`	No description.
`api_key`	`str`	No description.
`api_token`	`str`	No description.
`api_user_service_key`	`str`	No description.
`base_url`	`str`	No description.
`email`	`str`	No description.
`user_agent_operator_suffix`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`meta_attributes`^Required

meta_attributes: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`terraform_provider_source`^Optional

terraform_provider_source: str

Type: str

`alias`^Optional

alias: str

Type: str

`alias_input`^Optional

alias_input: str

Type: str

`api_key_input`^Optional

api_key_input: str

Type: str

`api_token_input`^Optional

api_token_input: str

Type: str

`api_user_service_key_input`^Optional

api_user_service_key_input: str

Type: str

`base_url_input`^Optional

base_url_input: str

Type: str

`email_input`^Optional

email_input: str

Type: str

`user_agent_operator_suffix_input`^Optional

user_agent_operator_suffix_input: str

Type: str

`api_key`^Optional

api_key: str

Type: str

`api_token`^Optional

api_token: str

Type: str

`api_user_service_key`^Optional

api_user_service_key: str

Type: str

`base_url`^Optional

base_url: str

Type: str

`email`^Optional

email: str

Type: str

`user_agent_operator_suffix`^Optional

user_agent_operator_suffix: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

CloudflareProviderConfig

Initializer

from cdktn_provider_cloudflare import provider

provider.CloudflareProviderConfig(
  alias: str = None,
  api_key: str = None,
  api_token: str = None,
  api_user_service_key: str = None,
  base_url: str = None,
  email: str = None,
  user_agent_operator_suffix: str = None
)

Properties

Name	Type	Description
`alias`	`str`	Alias name.
`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.
`base_url`	`str`	Value to override the default HTTP client base URL. Alternatively, can be configured using the `base_url` environment variable.
`email`	`str`	A registered Cloudflare email address.
`user_agent_operator_suffix`	`str`	A value to append to the HTTP User Agent for all API calls.

`alias`^Optional

alias: str

Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#alias CloudflareProvider#alias}

`api_key`^Optional

api_key: str

Type: str

The API key for operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_key CloudflareProvider#api_key}

`api_token`^Optional

api_token: str

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_token CloudflareProvider#api_token}

`api_user_service_key`^Optional

api_user_service_key: str

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_user_service_key CloudflareProvider#api_user_service_key}

`base_url`^Optional

base_url: str

Type: str

Value to override the default HTTP client base URL. Alternatively, can be configured using the base_url environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#base_url CloudflareProvider#base_url}

`email`^Optional

email: str

Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#email CloudflareProvider#email}

`user_agent_operator_suffix`^Optional

user_agent_operator_suffix: str

Type: str

A value to append to the HTTP User Agent for all API calls.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#user_agent_operator_suffix CloudflareProvider#user_agent_operator_suffix}

FilesExpand file tree

provider.python.md

Latest commit

History

provider.python.md

File metadata and controls

provider Submodule

Constructs

CloudflareProvider

Initializers

scopeRequired

idRequired

aliasOptional

api_keyOptional

api_tokenOptional

api_user_service_keyOptional

base_urlOptional

emailOptional

user_agent_operator_suffixOptional

Methods

to_string

with

mixinsRequired

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

reset_alias

reset_api_key

reset_api_token

reset_api_user_service_key

reset_base_url

reset_email

reset_user_agent_operator_suffix

Static Functions

is_construct

xRequired

is_terraform_element

xRequired

is_terraform_provider

xRequired

generate_config_for_import

scopeRequired

import_to_idRequired

import_from_idRequired

providerOptional

Properties

nodeRequired

cdktf_stackRequired

fqnRequired

friendly_unique_idRequired

meta_attributesRequired

terraform_resource_typeRequired

terraform_generator_metadataOptional

terraform_provider_sourceOptional

aliasOptional

alias_inputOptional

api_key_inputOptional

api_token_inputOptional

api_user_service_key_inputOptional

base_url_inputOptional

email_inputOptional

user_agent_operator_suffix_inputOptional

api_keyOptional

api_tokenOptional

api_user_service_keyOptional

base_urlOptional

emailOptional

user_agent_operator_suffixOptional

Constants

tfResourceTypeRequired

Structs

CloudflareProviderConfig

Initializer

Properties

`provider` Submodule

`scope`^Required

`id`^Required

`alias`^Optional

`api_key`^Optional

`api_token`^Optional

`api_user_service_key`^Optional

`base_url`^Optional

`email`^Optional

`user_agent_operator_suffix`^Optional

`to_string`

`with`

`mixins`^Required

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`reset_alias`

`reset_api_key`

`reset_api_token`

`reset_api_user_service_key`

`reset_base_url`

`reset_email`

`reset_user_agent_operator_suffix`

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_terraform_provider`

`x`^Required

`generate_config_for_import`

`scope`^Required

`import_to_id`^Required

`import_from_id`^Required

`provider`^Optional

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required

`meta_attributes`^Required

`terraform_resource_type`^Required

`terraform_generator_metadata`^Optional

`terraform_provider_source`^Optional

`alias`^Optional

`alias_input`^Optional

`api_key_input`^Optional

`api_token_input`^Optional

`api_user_service_key_input`^Optional

`base_url_input`^Optional

`email_input`^Optional

`user_agent_operator_suffix_input`^Optional

`api_key`^Optional

`api_token`^Optional

`api_user_service_key`^Optional

`base_url`^Optional

`email`^Optional

`user_agent_operator_suffix`^Optional

`tfResourceType`^Required

`alias`^Optional

`api_key`^Optional

`api_token`^Optional

`api_user_service_key`^Optional

`base_url`^Optional

`email`^Optional

`user_agent_operator_suffix`^Optional