Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget cloudflare_turnstile_widget}.
from cdktn_provider_cloudflare import turnstile_widget
turnstileWidget.TurnstileWidget(
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,
domains: typing.List[str],
mode: str,
name: str,
account_id: str = None,
bot_fight_mode: bool | IResolvable = None,
clearance_level: str = None,
ephemeral_id: bool | IResolvable = None,
offlabel: bool | IResolvable = None,
region: str = 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. |
domains |
typing.List[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#domains TurnstileWidget#domains}. |
mode |
str |
Widget Mode Available values: "non-interactive", "invisible", "managed". |
name |
str |
Human readable widget name. |
account_id |
str |
Identifier. |
bot_fight_mode |
bool | cdktn.IResolvable |
If bot_fight_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). |
clearance_level |
str |
If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive". |
ephemeral_id |
bool | cdktn.IResolvable |
Return the Ephemeral ID in /siteverify (ENT only). |
offlabel |
bool | cdktn.IResolvable |
Do not show any Cloudflare branding on the widget (ENT only). |
region |
str |
Region where this widget can be used. This cannot be changed after creation. Available values: "world", "china". |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
- Type: typing.Union[int, float] | cdktn.TerraformCount
- Type: typing.List[cdktn.ITerraformDependable]
- Type: cdktn.ITerraformIterator
- Type: cdktn.TerraformResourceLifecycle
- Type: cdktn.TerraformProvider
- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
- Type: typing.List[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#domains TurnstileWidget#domains}.
- Type: str
Widget Mode Available values: "non-interactive", "invisible", "managed".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#mode TurnstileWidget#mode}
- Type: str
Human readable widget name.
Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#name TurnstileWidget#name}
- Type: str
Identifier.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#account_id TurnstileWidget#account_id}
- Type: bool | cdktn.IResolvable
If bot_fight_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#bot_fight_mode TurnstileWidget#bot_fight_mode}
- Type: str
If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#clearance_level TurnstileWidget#clearance_level}
- Type: bool | cdktn.IResolvable
Return the Ephemeral ID in /siteverify (ENT only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#ephemeral_id TurnstileWidget#ephemeral_id}
- Type: bool | cdktn.IResolvable
Do not show any Cloudflare branding on the widget (ENT only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#offlabel TurnstileWidget#offlabel}
- Type: str
Region where this widget can be used. This cannot be changed after creation. Available values: "world", "china".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#region TurnstileWidget#region}
| 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". |
reset_account_id |
No description. |
reset_bot_fight_mode |
No description. |
reset_clearance_level |
No description. |
reset_ephemeral_id |
No description. |
reset_offlabel |
No description. |
reset_region |
No description. |
def to_string() -> strReturns a string representation of this construct.
def with(
mixins: *IMixin
) -> IConstructApplies 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.
- Type: *constructs.IMixin
The mixins to apply.
def add_override(
path: str,
value: typing.Any
) -> None- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> NoneOverrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> NoneResets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Anydef to_metadata() -> typing.Anydef to_terraform() -> typing.AnyAdds this resource to the terraform JSON output.
def add_move_target(
move_target: str
) -> NoneAdds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: str
The string move target that will correspond to this resource.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]- Type: str
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveByIddef import_from(
id: str,
provider: TerraformProvider = None
) -> None- Type: str
- Type: cdktn.TerraformProvider
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def move_from_id(
id: str
) -> NoneMove 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.
- Type: str
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
def move_to(
move_target: str,
index: str | typing.Union[int, float] = None
) -> NoneMoves this resource to the target resource given by moveTarget.
- Type: str
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- 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.
def move_to_id(
id: str
) -> NoneMoves this resource to the resource corresponding to "id".
- Type: str
Full id of resource to move to, e.g. "aws_s3_bucket.example".
def reset_account_id() -> Nonedef reset_bot_fight_mode() -> Nonedef reset_clearance_level() -> Nonedef reset_ephemeral_id() -> Nonedef reset_offlabel() -> Nonedef reset_region() -> None| 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 TurnstileWidget resource upon running "cdktn plan ". |
from cdktn_provider_cloudflare import turnstile_widget
turnstileWidget.TurnstileWidget.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.
- Type: typing.Any
Any object.
from cdktn_provider_cloudflare import turnstile_widget
turnstileWidget.TurnstileWidget.is_terraform_element(
x: typing.Any
)- Type: typing.Any
from cdktn_provider_cloudflare import turnstile_widget
turnstileWidget.TurnstileWidget.is_terraform_resource(
x: typing.Any
)- Type: typing.Any
from cdktn_provider_cloudflare import turnstile_widget
turnstileWidget.TurnstileWidget.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)Generates CDKTN code for importing a TurnstileWidget resource upon running "cdktn plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the TurnstileWidget to import.
- Type: str
The id of the existing TurnstileWidget that should be imported.
Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#import import section} in the documentation of this resource for the id to use
- Type: cdktn.TerraformProvider
? Optional instance of the provider where the TurnstileWidget to import is found.
| 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. |
id |
str |
No description. |
modified_on |
str |
No description. |
secret |
str |
No description. |
sitekey |
str |
No description. |
account_id_input |
str |
No description. |
bot_fight_mode_input |
bool | cdktn.IResolvable |
No description. |
clearance_level_input |
str |
No description. |
domains_input |
typing.List[str] |
No description. |
ephemeral_id_input |
bool | cdktn.IResolvable |
No description. |
mode_input |
str |
No description. |
name_input |
str |
No description. |
offlabel_input |
bool | cdktn.IResolvable |
No description. |
region_input |
str |
No description. |
account_id |
str |
No description. |
bot_fight_mode |
bool | cdktn.IResolvable |
No description. |
clearance_level |
str |
No description. |
domains |
typing.List[str] |
No description. |
ephemeral_id |
bool | cdktn.IResolvable |
No description. |
mode |
str |
No description. |
name |
str |
No description. |
offlabel |
bool | cdktn.IResolvable |
No description. |
region |
str |
No description. |
node: Node- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack- Type: cdktn.TerraformStack
fqn: str- Type: str
friendly_unique_id: str- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]- Type: typing.Mapping[typing.Any]
terraform_resource_type: str- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata- Type: cdktn.TerraformProviderGeneratorMetadata
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktn.TerraformCount
depends_on: typing.List[str]- Type: typing.List[str]
for_each: ITerraformIterator- Type: cdktn.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktn.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktn.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
created_on: str- Type: str
id: str- Type: str
modified_on: str- Type: str
secret: str- Type: str
sitekey: str- Type: str
account_id_input: str- Type: str
bot_fight_mode_input: bool | IResolvable- Type: bool | cdktn.IResolvable
clearance_level_input: str- Type: str
domains_input: typing.List[str]- Type: typing.List[str]
ephemeral_id_input: bool | IResolvable- Type: bool | cdktn.IResolvable
mode_input: str- Type: str
name_input: str- Type: str
offlabel_input: bool | IResolvable- Type: bool | cdktn.IResolvable
region_input: str- Type: str
account_id: str- Type: str
bot_fight_mode: bool | IResolvable- Type: bool | cdktn.IResolvable
clearance_level: str- Type: str
domains: typing.List[str]- Type: typing.List[str]
ephemeral_id: bool | IResolvable- Type: bool | cdktn.IResolvable
mode: str- Type: str
name: str- Type: str
offlabel: bool | IResolvable- Type: bool | cdktn.IResolvable
region: str- Type: str
| Name | Type | Description |
|---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str- Type: str
from cdktn_provider_cloudflare import turnstile_widget
turnstileWidget.TurnstileWidgetConfig(
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,
domains: typing.List[str],
mode: str,
name: str,
account_id: str = None,
bot_fight_mode: bool | IResolvable = None,
clearance_level: str = None,
ephemeral_id: bool | IResolvable = None,
offlabel: bool | IResolvable = None,
region: str = None
)| 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. |
domains |
typing.List[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#domains TurnstileWidget#domains}. |
mode |
str |
Widget Mode Available values: "non-interactive", "invisible", "managed". |
name |
str |
Human readable widget name. |
account_id |
str |
Identifier. |
bot_fight_mode |
bool | cdktn.IResolvable |
If bot_fight_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). |
clearance_level |
str |
If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive". |
ephemeral_id |
bool | cdktn.IResolvable |
Return the Ephemeral ID in /siteverify (ENT only). |
offlabel |
bool | cdktn.IResolvable |
Do not show any Cloudflare branding on the widget (ENT only). |
region |
str |
Region where this widget can be used. This cannot be changed after creation. Available values: "world", "china". |
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktn.TerraformCount
depends_on: typing.List[ITerraformDependable]- Type: typing.List[cdktn.ITerraformDependable]
for_each: ITerraformIterator- Type: cdktn.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktn.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktn.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
domains: typing.List[str]- Type: typing.List[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#domains TurnstileWidget#domains}.
mode: str- Type: str
Widget Mode Available values: "non-interactive", "invisible", "managed".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#mode TurnstileWidget#mode}
name: str- Type: str
Human readable widget name.
Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#name TurnstileWidget#name}
account_id: str- Type: str
Identifier.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#account_id TurnstileWidget#account_id}
bot_fight_mode: bool | IResolvable- Type: bool | cdktn.IResolvable
If bot_fight_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#bot_fight_mode TurnstileWidget#bot_fight_mode}
clearance_level: str- Type: str
If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#clearance_level TurnstileWidget#clearance_level}
ephemeral_id: bool | IResolvable- Type: bool | cdktn.IResolvable
Return the Ephemeral ID in /siteverify (ENT only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#ephemeral_id TurnstileWidget#ephemeral_id}
offlabel: bool | IResolvable- Type: bool | cdktn.IResolvable
Do not show any Cloudflare branding on the widget (ENT only).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#offlabel TurnstileWidget#offlabel}
region: str- Type: str
Region where this widget can be used. This cannot be changed after creation. Available values: "world", "china".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/turnstile_widget#region TurnstileWidget#region}