Skip to content

listItem.python.md

Latest commit

 

History

History
2384 lines (1518 loc) · 94.8 KB

listItem.python.md

File metadata and controls

2384 lines (1518 loc) · 94.8 KB

listItem Submodule

Constructs

ListItem

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

Initializers 

from cdktn_provider_cloudflare import list_item

listItem.ListItem(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  list_id: str,
  account_id: str = None,
  asn: typing.Union[int, float] = None,
  comment: str = None,
  hostname: ListItemHostname = None,
  ip: str = None,
  redirect: ListItemRedirect = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
list_id str The unique ID of the list.
account_id str The Account ID for this resource.
asn typing.Union[int, float] A non-negative 32 bit integer.
comment str An informative summary of the list item.
hostname ListItemHostname Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
ip str An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
redirect ListItemRedirect The definition of the redirect.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional
  • Type: cdktn.ITerraformIterator
lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle
providerOptional
  • Type: cdktn.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
list_idRequired
  • Type: str

The unique ID of the list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#list_id ListItem#list_id}

account_idOptional
  • Type: str

The Account ID for this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#account_id ListItem#account_id}

asnOptional
  • Type: typing.Union[int, float]

A non-negative 32 bit integer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#asn ListItem#asn}

commentOptional
  • Type: str

An informative summary of the list item.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#comment ListItem#comment}

hostnameOptional

Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#hostname ListItem#hostname}

ipOptional
  • Type: str

An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#ip ListItem#ip}

redirectOptional

The definition of the redirect.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#redirect ListItem#redirect}

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.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_hostname No description.
put_redirect No description.
reset_account_id No description.
reset_asn No description.
reset_comment No description.
reset_hostname No description.
reset_ip No description.
reset_redirect 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.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • 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_idRequired
  • 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.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: str | typing.Union[int, float]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_hostname 
def put_hostname(
  url_hostname: str,
  exclude_exact_hostname: bool | IResolvable = None
) -> None
url_hostnameRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#url_hostname ListItem#url_hostname}.

exclude_exact_hostnameOptional
  • Type: bool | cdktn.IResolvable

Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#exclude_exact_hostname ListItem#exclude_exact_hostname}

put_redirect 
def put_redirect(
  source_url: str,
  target_url: str,
  include_subdomains: bool | IResolvable = None,
  preserve_path_suffix: bool | IResolvable = None,
  preserve_query_string: bool | IResolvable = None,
  status_code: typing.Union[int, float] = None,
  subpath_matching: bool | IResolvable = None
) -> None
source_urlRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#source_url ListItem#source_url}.

target_urlRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#target_url ListItem#target_url}.

include_subdomainsOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#include_subdomains ListItem#include_subdomains}.

preserve_path_suffixOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#preserve_path_suffix ListItem#preserve_path_suffix}.

preserve_query_stringOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#preserve_query_string ListItem#preserve_query_string}.

status_codeOptional
  • Type: typing.Union[int, float]

Available values: 301, 302, 307, 308.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#status_code ListItem#status_code}

subpath_matchingOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#subpath_matching ListItem#subpath_matching}.

reset_account_id 
def reset_account_id() -> None
reset_asn 
def reset_asn() -> None
reset_comment 
def reset_comment() -> None
reset_hostname 
def reset_hostname() -> None
reset_ip 
def reset_ip() -> None
reset_redirect 
def reset_redirect() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a ListItem resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_cloudflare import list_item

listItem.ListItem.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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktn_provider_cloudflare import list_item

listItem.ListItem.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_cloudflare import list_item

listItem.ListItem.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_cloudflare import list_item

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

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing ListItem that should be imported.

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

providerOptional
  • Type: cdktn.TerraformProvider

? Optional instance of the provider where the ListItem 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.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
created_on str No description.
hostname ListItemHostnameOutputReference No description.
id str No description.
modified_on str No description.
operation_id str No description.
redirect ListItemRedirectOutputReference No description.
account_id_input str No description.
asn_input typing.Union[int, float] No description.
comment_input str No description.
hostname_input cdktn.IResolvable | ListItemHostname No description.
ip_input str No description.
list_id_input str No description.
redirect_input cdktn.IResolvable | ListItemRedirect No description.
account_id str No description.
asn typing.Union[int, float] No description.
comment str No description.
ip str No description.
list_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
created_onRequired 
created_on: str
  • Type: str
hostnameRequired 
hostname: ListItemHostnameOutputReference
idRequired 
id: str
  • Type: str
modified_onRequired 
modified_on: str
  • Type: str
operation_idRequired 
operation_id: str
  • Type: str
redirectRequired 
redirect: ListItemRedirectOutputReference
account_id_inputOptional 
account_id_input: str
  • Type: str
asn_inputOptional 
asn_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
comment_inputOptional 
comment_input: str
  • Type: str
hostname_inputOptional 
hostname_input: IResolvable | ListItemHostname
ip_inputOptional 
ip_input: str
  • Type: str
list_id_inputOptional 
list_id_input: str
  • Type: str
redirect_inputOptional 
redirect_input: IResolvable | ListItemRedirect
account_idRequired 
account_id: str
  • Type: str
asnRequired 
asn: typing.Union[int, float]
  • Type: typing.Union[int, float]
commentRequired 
comment: str
  • Type: str
ipRequired 
ip: str
  • Type: str
list_idRequired 
list_id: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

ListItemConfig

Initializer 

from cdktn_provider_cloudflare import list_item

listItem.ListItemConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  list_id: str,
  account_id: str = None,
  asn: typing.Union[int, float] = None,
  comment: str = None,
  hostname: ListItemHostname = None,
  ip: str = None,
  redirect: ListItemRedirect = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
list_id str The unique ID of the list.
account_id str The Account ID for this resource.
asn typing.Union[int, float] A non-negative 32 bit integer.
comment str An informative summary of the list item.
hostname ListItemHostname Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
ip str An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
redirect ListItemRedirect The definition of the redirect.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
list_idRequired 
list_id: str
  • Type: str

The unique ID of the list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#list_id ListItem#list_id}

account_idOptional 
account_id: str
  • Type: str

The Account ID for this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#account_id ListItem#account_id}

asnOptional 
asn: typing.Union[int, float]
  • Type: typing.Union[int, float]

A non-negative 32 bit integer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#asn ListItem#asn}

commentOptional 
comment: str
  • Type: str

An informative summary of the list item.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#comment ListItem#comment}

hostnameOptional 
hostname: ListItemHostname

Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#hostname ListItem#hostname}

ipOptional 
ip: str
  • Type: str

An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#ip ListItem#ip}

redirectOptional 
redirect: ListItemRedirect

The definition of the redirect.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#redirect ListItem#redirect}

ListItemHostname

Initializer 

from cdktn_provider_cloudflare import list_item

listItem.ListItemHostname(
  url_hostname: str,
  exclude_exact_hostname: bool | IResolvable = None
)

Properties

Name Type Description
url_hostname str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#url_hostname ListItem#url_hostname}.
exclude_exact_hostname bool | cdktn.IResolvable Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
url_hostnameRequired 
url_hostname: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#url_hostname ListItem#url_hostname}.

exclude_exact_hostnameOptional 
exclude_exact_hostname: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#exclude_exact_hostname ListItem#exclude_exact_hostname}

ListItemRedirect

Initializer 

from cdktn_provider_cloudflare import list_item

listItem.ListItemRedirect(
  source_url: str,
  target_url: str,
  include_subdomains: bool | IResolvable = None,
  preserve_path_suffix: bool | IResolvable = None,
  preserve_query_string: bool | IResolvable = None,
  status_code: typing.Union[int, float] = None,
  subpath_matching: bool | IResolvable = None
)

Properties

Name Type Description
source_url str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#source_url ListItem#source_url}.
target_url str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#target_url ListItem#target_url}.
include_subdomains bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#include_subdomains ListItem#include_subdomains}.
preserve_path_suffix bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#preserve_path_suffix ListItem#preserve_path_suffix}.
preserve_query_string bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#preserve_query_string ListItem#preserve_query_string}.
status_code typing.Union[int, float] Available values: 301, 302, 307, 308.
subpath_matching bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#subpath_matching ListItem#subpath_matching}.
source_urlRequired 
source_url: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#source_url ListItem#source_url}.

target_urlRequired 
target_url: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#target_url ListItem#target_url}.

include_subdomainsOptional 
include_subdomains: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#include_subdomains ListItem#include_subdomains}.

preserve_path_suffixOptional 
preserve_path_suffix: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#preserve_path_suffix ListItem#preserve_path_suffix}.

preserve_query_stringOptional 
preserve_query_string: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#preserve_query_string ListItem#preserve_query_string}.

status_codeOptional 
status_code: typing.Union[int, float]
  • Type: typing.Union[int, float]

Available values: 301, 302, 307, 308.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#status_code ListItem#status_code}

subpath_matchingOptional 
subpath_matching: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/list_item#subpath_matching ListItem#subpath_matching}.

Classes

ListItemHostnameOutputReference

Initializers 

from cdktn_provider_cloudflare import list_item

listItem.ListItemHostnameOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_exclude_exact_hostname No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktn.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_exclude_exact_hostname 
def reset_exclude_exact_hostname() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
exclude_exact_hostname_input bool | cdktn.IResolvable No description.
url_hostname_input str No description.
exclude_exact_hostname bool | cdktn.IResolvable No description.
url_hostname str No description.
internal_value cdktn.IResolvable | ListItemHostname No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
exclude_exact_hostname_inputOptional 
exclude_exact_hostname_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
url_hostname_inputOptional 
url_hostname_input: str
  • Type: str
exclude_exact_hostnameRequired 
exclude_exact_hostname: bool | IResolvable
  • Type: bool | cdktn.IResolvable
url_hostnameRequired 
url_hostname: str
  • Type: str
internal_valueOptional 
internal_value: IResolvable | ListItemHostname

ListItemRedirectOutputReference

Initializers 

from cdktn_provider_cloudflare import list_item

listItem.ListItemRedirectOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_include_subdomains No description.
reset_preserve_path_suffix No description.
reset_preserve_query_string No description.
reset_status_code No description.
reset_subpath_matching No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktn.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_include_subdomains 
def reset_include_subdomains() -> None
reset_preserve_path_suffix 
def reset_preserve_path_suffix() -> None
reset_preserve_query_string 
def reset_preserve_query_string() -> None
reset_status_code 
def reset_status_code() -> None
reset_subpath_matching 
def reset_subpath_matching() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
include_subdomains_input bool | cdktn.IResolvable No description.
preserve_path_suffix_input bool | cdktn.IResolvable No description.
preserve_query_string_input bool | cdktn.IResolvable No description.
source_url_input str No description.
status_code_input typing.Union[int, float] No description.
subpath_matching_input bool | cdktn.IResolvable No description.
target_url_input str No description.
include_subdomains bool | cdktn.IResolvable No description.
preserve_path_suffix bool | cdktn.IResolvable No description.
preserve_query_string bool | cdktn.IResolvable No description.
source_url str No description.
status_code typing.Union[int, float] No description.
subpath_matching bool | cdktn.IResolvable No description.
target_url str No description.
internal_value cdktn.IResolvable | ListItemRedirect No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
include_subdomains_inputOptional 
include_subdomains_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
preserve_path_suffix_inputOptional 
preserve_path_suffix_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
preserve_query_string_inputOptional 
preserve_query_string_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
source_url_inputOptional 
source_url_input: str
  • Type: str
status_code_inputOptional 
status_code_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
subpath_matching_inputOptional 
subpath_matching_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
target_url_inputOptional 
target_url_input: str
  • Type: str
include_subdomainsRequired 
include_subdomains: bool | IResolvable
  • Type: bool | cdktn.IResolvable
preserve_path_suffixRequired 
preserve_path_suffix: bool | IResolvable
  • Type: bool | cdktn.IResolvable
preserve_query_stringRequired 
preserve_query_string: bool | IResolvable
  • Type: bool | cdktn.IResolvable
source_urlRequired 
source_url: str
  • Type: str
status_codeRequired 
status_code: typing.Union[int, float]
  • Type: typing.Union[int, float]
subpath_matchingRequired 
subpath_matching: bool | IResolvable
  • Type: bool | cdktn.IResolvable
target_urlRequired 
target_url: str
  • Type: str
internal_valueOptional 
internal_value: IResolvable | ListItemRedirect