Skip to content

botManagement.python.md

Latest commit

 

History

History
2211 lines (1406 loc) · 98.6 KB

botManagement.python.md

File metadata and controls

2211 lines (1406 loc) · 98.6 KB

botManagement Submodule

Constructs

BotManagement

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

Initializers 

from cdktn_provider_cloudflare import bot_management

botManagement.BotManagement(
  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,
  zone_id: str,
  ai_bots_protection: str = None,
  auto_update_model: bool | IResolvable = None,
  bm_cookie_enabled: bool | IResolvable = None,
  cf_robots_variant: str = None,
  content_bots_protection: str = None,
  crawler_protection: str = None,
  enable_js: bool | IResolvable = None,
  fight_mode: bool | IResolvable = None,
  is_robots_txt_managed: bool | IResolvable = None,
  optimize_wordpress: bool | IResolvable = None,
  sbfm_definitely_automated: str = None,
  sbfm_likely_automated: str = None,
  sbfm_static_resource_protection: bool | IResolvable = None,
  sbfm_verified_bots: str = None,
  suppress_session_score: bool | IResolvable = 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.
zone_id str Identifier.
ai_bots_protection str Enable rule to block AI Scrapers and Crawlers.
auto_update_model bool | cdktn.IResolvable Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more..
bm_cookie_enabled bool | cdktn.IResolvable Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true.
cf_robots_variant str Specifies the Robots Access Control License variant to use. Available values: "off", "policy_only".
content_bots_protection str Enable rule to block content bots.
crawler_protection str Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
enable_js bool | cdktn.IResolvable Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
fight_mode bool | cdktn.IResolvable Whether to enable Bot Fight Mode.
is_robots_txt_managed bool | cdktn.IResolvable Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.
optimize_wordpress bool | cdktn.IResolvable Whether to optimize Super Bot Fight Mode protections for Wordpress.
sbfm_definitely_automated str Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
sbfm_likely_automated str Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
sbfm_static_resource_protection bool | cdktn.IResolvable Super Bot Fight Mode (SBFM) to enable static resource protection.
sbfm_verified_bots str Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
suppress_session_score bool | cdktn.IResolvable Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
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]
zone_idRequired
  • Type: str

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#zone_id BotManagement#zone_id}

ai_bots_protectionOptional
  • Type: str

Enable rule to block AI Scrapers and Crawlers.

Please note the value only_on_ad_pages is currently not available for Enterprise customers. Available values: "block", "disabled", "only_on_ad_pages".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#ai_bots_protection BotManagement#ai_bots_protection}

auto_update_modelOptional
  • Type: bool | cdktn.IResolvable

Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#auto_update_model BotManagement#auto_update_model}

bm_cookie_enabledOptional
  • Type: bool | cdktn.IResolvable

Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#bm_cookie_enabled BotManagement#bm_cookie_enabled}

cf_robots_variantOptional
  • Type: str

Specifies the Robots Access Control License variant to use. Available values: "off", "policy_only".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#cf_robots_variant BotManagement#cf_robots_variant}

content_bots_protectionOptional
  • Type: str

Enable rule to block content bots.

When enabled, blocks automated traffic with low bot scores, excluding safe verified bot categories. Exceptions should be managed via skip rules. Available values: "block", "disabled".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#content_bots_protection BotManagement#content_bots_protection}

crawler_protectionOptional
  • Type: str

Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#crawler_protection BotManagement#crawler_protection}

enable_jsOptional
  • Type: bool | cdktn.IResolvable

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#enable_js BotManagement#enable_js}

fight_modeOptional
  • Type: bool | cdktn.IResolvable

Whether to enable Bot Fight Mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#fight_mode BotManagement#fight_mode}

is_robots_txt_managedOptional
  • Type: bool | cdktn.IResolvable

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#is_robots_txt_managed BotManagement#is_robots_txt_managed}

optimize_wordpressOptional
  • Type: bool | cdktn.IResolvable

Whether to optimize Super Bot Fight Mode protections for Wordpress.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#optimize_wordpress BotManagement#optimize_wordpress}

sbfm_definitely_automatedOptional
  • Type: str

Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_definitely_automated BotManagement#sbfm_definitely_automated}

sbfm_likely_automatedOptional
  • Type: str

Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_likely_automated BotManagement#sbfm_likely_automated}

sbfm_static_resource_protectionOptional
  • Type: bool | cdktn.IResolvable

Super Bot Fight Mode (SBFM) to enable static resource protection.

Enable if static resources on your application need bot protection. Note: Static resource protection can also result in legitimate traffic being blocked.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_static_resource_protection BotManagement#sbfm_static_resource_protection}

sbfm_verified_botsOptional
  • Type: str

Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_verified_bots BotManagement#sbfm_verified_bots}

suppress_session_scoreOptional
  • Type: bool | cdktn.IResolvable

Whether to disable tracking the highest bot score for a session in the Bot Management cookie.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#suppress_session_score BotManagement#suppress_session_score}

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".
reset_ai_bots_protection No description.
reset_auto_update_model No description.
reset_bm_cookie_enabled No description.
reset_cf_robots_variant No description.
reset_content_bots_protection No description.
reset_crawler_protection No description.
reset_enable_js No description.
reset_fight_mode No description.
reset_is_robots_txt_managed No description.
reset_optimize_wordpress No description.
reset_sbfm_definitely_automated No description.
reset_sbfm_likely_automated No description.
reset_sbfm_static_resource_protection No description.
reset_sbfm_verified_bots No description.
reset_suppress_session_score 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".

reset_ai_bots_protection 
def reset_ai_bots_protection() -> None
reset_auto_update_model 
def reset_auto_update_model() -> None
reset_bm_cookie_enabled 
def reset_bm_cookie_enabled() -> None
reset_cf_robots_variant 
def reset_cf_robots_variant() -> None
reset_content_bots_protection 
def reset_content_bots_protection() -> None
reset_crawler_protection 
def reset_crawler_protection() -> None
reset_enable_js 
def reset_enable_js() -> None
reset_fight_mode 
def reset_fight_mode() -> None
reset_is_robots_txt_managed 
def reset_is_robots_txt_managed() -> None
reset_optimize_wordpress 
def reset_optimize_wordpress() -> None
reset_sbfm_definitely_automated 
def reset_sbfm_definitely_automated() -> None
reset_sbfm_likely_automated 
def reset_sbfm_likely_automated() -> None
reset_sbfm_static_resource_protection 
def reset_sbfm_static_resource_protection() -> None
reset_sbfm_verified_bots 
def reset_sbfm_verified_bots() -> None
reset_suppress_session_score 
def reset_suppress_session_score() -> 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 BotManagement resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_cloudflare import bot_management

botManagement.BotManagement.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 bot_management

botManagement.BotManagement.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_cloudflare import bot_management

botManagement.BotManagement.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_cloudflare import bot_management

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

Generates CDKTN code for importing a BotManagement 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 BotManagement to import.

import_from_idRequired
  • Type: str

The id of the existing BotManagement that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#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 BotManagement 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.
id str No description.
stale_zone_configuration BotManagementStaleZoneConfigurationOutputReference No description.
using_latest_model cdktn.IResolvable No description.
ai_bots_protection_input str No description.
auto_update_model_input bool | cdktn.IResolvable No description.
bm_cookie_enabled_input bool | cdktn.IResolvable No description.
cf_robots_variant_input str No description.
content_bots_protection_input str No description.
crawler_protection_input str No description.
enable_js_input bool | cdktn.IResolvable No description.
fight_mode_input bool | cdktn.IResolvable No description.
is_robots_txt_managed_input bool | cdktn.IResolvable No description.
optimize_wordpress_input bool | cdktn.IResolvable No description.
sbfm_definitely_automated_input str No description.
sbfm_likely_automated_input str No description.
sbfm_static_resource_protection_input bool | cdktn.IResolvable No description.
sbfm_verified_bots_input str No description.
suppress_session_score_input bool | cdktn.IResolvable No description.
zone_id_input str No description.
ai_bots_protection str No description.
auto_update_model bool | cdktn.IResolvable No description.
bm_cookie_enabled bool | cdktn.IResolvable No description.
cf_robots_variant str No description.
content_bots_protection str No description.
crawler_protection str No description.
enable_js bool | cdktn.IResolvable No description.
fight_mode bool | cdktn.IResolvable No description.
is_robots_txt_managed bool | cdktn.IResolvable No description.
optimize_wordpress bool | cdktn.IResolvable No description.
sbfm_definitely_automated str No description.
sbfm_likely_automated str No description.
sbfm_static_resource_protection bool | cdktn.IResolvable No description.
sbfm_verified_bots str No description.
suppress_session_score bool | cdktn.IResolvable No description.
zone_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]
idRequired 
id: str
  • Type: str
stale_zone_configurationRequired 
stale_zone_configuration: BotManagementStaleZoneConfigurationOutputReference
using_latest_modelRequired 
using_latest_model: IResolvable
  • Type: cdktn.IResolvable
ai_bots_protection_inputOptional 
ai_bots_protection_input: str
  • Type: str
auto_update_model_inputOptional 
auto_update_model_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
bm_cookie_enabled_inputOptional 
bm_cookie_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
cf_robots_variant_inputOptional 
cf_robots_variant_input: str
  • Type: str
content_bots_protection_inputOptional 
content_bots_protection_input: str
  • Type: str
crawler_protection_inputOptional 
crawler_protection_input: str
  • Type: str
enable_js_inputOptional 
enable_js_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
fight_mode_inputOptional 
fight_mode_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
is_robots_txt_managed_inputOptional 
is_robots_txt_managed_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
optimize_wordpress_inputOptional 
optimize_wordpress_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
sbfm_definitely_automated_inputOptional 
sbfm_definitely_automated_input: str
  • Type: str
sbfm_likely_automated_inputOptional 
sbfm_likely_automated_input: str
  • Type: str
sbfm_static_resource_protection_inputOptional 
sbfm_static_resource_protection_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
sbfm_verified_bots_inputOptional 
sbfm_verified_bots_input: str
  • Type: str
suppress_session_score_inputOptional 
suppress_session_score_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
zone_id_inputOptional 
zone_id_input: str
  • Type: str
ai_bots_protectionRequired 
ai_bots_protection: str
  • Type: str
auto_update_modelRequired 
auto_update_model: bool | IResolvable
  • Type: bool | cdktn.IResolvable
bm_cookie_enabledRequired 
bm_cookie_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
cf_robots_variantRequired 
cf_robots_variant: str
  • Type: str
content_bots_protectionRequired 
content_bots_protection: str
  • Type: str
crawler_protectionRequired 
crawler_protection: str
  • Type: str
enable_jsRequired 
enable_js: bool | IResolvable
  • Type: bool | cdktn.IResolvable
fight_modeRequired 
fight_mode: bool | IResolvable
  • Type: bool | cdktn.IResolvable
is_robots_txt_managedRequired 
is_robots_txt_managed: bool | IResolvable
  • Type: bool | cdktn.IResolvable
optimize_wordpressRequired 
optimize_wordpress: bool | IResolvable
  • Type: bool | cdktn.IResolvable
sbfm_definitely_automatedRequired 
sbfm_definitely_automated: str
  • Type: str
sbfm_likely_automatedRequired 
sbfm_likely_automated: str
  • Type: str
sbfm_static_resource_protectionRequired 
sbfm_static_resource_protection: bool | IResolvable
  • Type: bool | cdktn.IResolvable
sbfm_verified_botsRequired 
sbfm_verified_bots: str
  • Type: str
suppress_session_scoreRequired 
suppress_session_score: bool | IResolvable
  • Type: bool | cdktn.IResolvable
zone_idRequired 
zone_id: str
  • Type: str

Constants

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

Structs

BotManagementConfig

Initializer 

from cdktn_provider_cloudflare import bot_management

botManagement.BotManagementConfig(
  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,
  zone_id: str,
  ai_bots_protection: str = None,
  auto_update_model: bool | IResolvable = None,
  bm_cookie_enabled: bool | IResolvable = None,
  cf_robots_variant: str = None,
  content_bots_protection: str = None,
  crawler_protection: str = None,
  enable_js: bool | IResolvable = None,
  fight_mode: bool | IResolvable = None,
  is_robots_txt_managed: bool | IResolvable = None,
  optimize_wordpress: bool | IResolvable = None,
  sbfm_definitely_automated: str = None,
  sbfm_likely_automated: str = None,
  sbfm_static_resource_protection: bool | IResolvable = None,
  sbfm_verified_bots: str = None,
  suppress_session_score: bool | IResolvable = 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.
zone_id str Identifier.
ai_bots_protection str Enable rule to block AI Scrapers and Crawlers.
auto_update_model bool | cdktn.IResolvable Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more..
bm_cookie_enabled bool | cdktn.IResolvable Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true.
cf_robots_variant str Specifies the Robots Access Control License variant to use. Available values: "off", "policy_only".
content_bots_protection str Enable rule to block content bots.
crawler_protection str Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
enable_js bool | cdktn.IResolvable Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
fight_mode bool | cdktn.IResolvable Whether to enable Bot Fight Mode.
is_robots_txt_managed bool | cdktn.IResolvable Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.
optimize_wordpress bool | cdktn.IResolvable Whether to optimize Super Bot Fight Mode protections for Wordpress.
sbfm_definitely_automated str Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
sbfm_likely_automated str Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
sbfm_static_resource_protection bool | cdktn.IResolvable Super Bot Fight Mode (SBFM) to enable static resource protection.
sbfm_verified_bots str Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
suppress_session_score bool | cdktn.IResolvable Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
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]
zone_idRequired 
zone_id: str
  • Type: str

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#zone_id BotManagement#zone_id}

ai_bots_protectionOptional 
ai_bots_protection: str
  • Type: str

Enable rule to block AI Scrapers and Crawlers.

Please note the value only_on_ad_pages is currently not available for Enterprise customers. Available values: "block", "disabled", "only_on_ad_pages".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#ai_bots_protection BotManagement#ai_bots_protection}

auto_update_modelOptional 
auto_update_model: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#auto_update_model BotManagement#auto_update_model}

bm_cookie_enabledOptional 
bm_cookie_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#bm_cookie_enabled BotManagement#bm_cookie_enabled}

cf_robots_variantOptional 
cf_robots_variant: str
  • Type: str

Specifies the Robots Access Control License variant to use. Available values: "off", "policy_only".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#cf_robots_variant BotManagement#cf_robots_variant}

content_bots_protectionOptional 
content_bots_protection: str
  • Type: str

Enable rule to block content bots.

When enabled, blocks automated traffic with low bot scores, excluding safe verified bot categories. Exceptions should be managed via skip rules. Available values: "block", "disabled".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#content_bots_protection BotManagement#content_bots_protection}

crawler_protectionOptional 
crawler_protection: str
  • Type: str

Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#crawler_protection BotManagement#crawler_protection}

enable_jsOptional 
enable_js: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#enable_js BotManagement#enable_js}

fight_modeOptional 
fight_mode: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Whether to enable Bot Fight Mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#fight_mode BotManagement#fight_mode}

is_robots_txt_managedOptional 
is_robots_txt_managed: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#is_robots_txt_managed BotManagement#is_robots_txt_managed}

optimize_wordpressOptional 
optimize_wordpress: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Whether to optimize Super Bot Fight Mode protections for Wordpress.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#optimize_wordpress BotManagement#optimize_wordpress}

sbfm_definitely_automatedOptional 
sbfm_definitely_automated: str
  • Type: str

Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_definitely_automated BotManagement#sbfm_definitely_automated}

sbfm_likely_automatedOptional 
sbfm_likely_automated: str
  • Type: str

Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_likely_automated BotManagement#sbfm_likely_automated}

sbfm_static_resource_protectionOptional 
sbfm_static_resource_protection: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Super Bot Fight Mode (SBFM) to enable static resource protection.

Enable if static resources on your application need bot protection. Note: Static resource protection can also result in legitimate traffic being blocked.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_static_resource_protection BotManagement#sbfm_static_resource_protection}

sbfm_verified_botsOptional 
sbfm_verified_bots: str
  • Type: str

Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#sbfm_verified_bots BotManagement#sbfm_verified_bots}

suppress_session_scoreOptional 
suppress_session_score: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Whether to disable tracking the highest bot score for a session in the Bot Management cookie.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/bot_management#suppress_session_score BotManagement#suppress_session_score}

BotManagementStaleZoneConfiguration

Initializer 

from cdktn_provider_cloudflare import bot_management

botManagement.BotManagementStaleZoneConfiguration()

Classes

BotManagementStaleZoneConfigurationOutputReference

Initializers 

from cdktn_provider_cloudflare import bot_management

botManagement.BotManagementStaleZoneConfigurationOutputReference(
  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.
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.

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.
fight_mode cdktn.IResolvable No description.
optimize_wordpress cdktn.IResolvable No description.
sbfm_definitely_automated str No description.
sbfm_likely_automated str No description.
sbfm_static_resource_protection str No description.
sbfm_verified_bots str No description.
suppress_session_score cdktn.IResolvable No description.
internal_value BotManagementStaleZoneConfiguration 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
fight_modeRequired 
fight_mode: IResolvable
  • Type: cdktn.IResolvable
optimize_wordpressRequired 
optimize_wordpress: IResolvable
  • Type: cdktn.IResolvable
sbfm_definitely_automatedRequired 
sbfm_definitely_automated: str
  • Type: str
sbfm_likely_automatedRequired 
sbfm_likely_automated: str
  • Type: str
sbfm_static_resource_protectionRequired 
sbfm_static_resource_protection: str
  • Type: str
sbfm_verified_botsRequired 
sbfm_verified_bots: str
  • Type: str
suppress_session_scoreRequired 
suppress_session_score: IResolvable
  • Type: cdktn.IResolvable
internal_valueOptional 
internal_value: BotManagementStaleZoneConfiguration