Skip to content

Latest commit

 

History

History
1989 lines (1261 loc) · 94.3 KB

zeroTrustDeviceProfiles.python.md

File metadata and controls

1989 lines (1261 loc) · 94.3 KB

zeroTrustDeviceProfiles Submodule

Constructs

ZeroTrustDeviceProfiles

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles cloudflare_zero_trust_device_profiles}.

Initializers

from cdktf_cdktf_provider_cloudflare import zero_trust_device_profiles

zeroTrustDeviceProfiles.ZeroTrustDeviceProfiles(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  account_id: str,
  description: str,
  name: str,
  allowed_to_leave: typing.Union[bool, IResolvable] = None,
  allow_mode_switch: typing.Union[bool, IResolvable] = None,
  allow_updates: typing.Union[bool, IResolvable] = None,
  auto_connect: typing.Union[int, float] = None,
  captive_portal: typing.Union[int, float] = None,
  default: typing.Union[bool, IResolvable] = None,
  disable_auto_fallback: typing.Union[bool, IResolvable] = None,
  enabled: typing.Union[bool, IResolvable] = None,
  exclude_office_ips: typing.Union[bool, IResolvable] = None,
  id: str = None,
  match: str = None,
  precedence: typing.Union[int, float] = None,
  service_mode_v2_mode: str = None,
  service_mode_v2_port: typing.Union[int, float] = None,
  support_url: str = None,
  switch_locked: typing.Union[bool, IResolvable] = None,
  tunnel_protocol: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
account_id str The account identifier to target for the resource.
description str Description of Policy.
name str Name of the policy.
allowed_to_leave typing.Union[bool, cdktf.IResolvable] Whether to allow devices to leave the organization. Defaults to true.
allow_mode_switch typing.Union[bool, cdktf.IResolvable] Whether to allow mode switch for this policy.
allow_updates typing.Union[bool, cdktf.IResolvable] Whether to allow updates under this policy.
auto_connect typing.Union[int, float] The amount of time in seconds to reconnect after having been disabled.
captive_portal typing.Union[int, float] The captive portal value for this policy. Defaults to 180.
default typing.Union[bool, cdktf.IResolvable] Whether the policy refers to the default account policy.
disable_auto_fallback typing.Union[bool, cdktf.IResolvable] Whether to disable auto fallback for this policy.
enabled typing.Union[bool, cdktf.IResolvable] Whether the policy is enabled (cannot be set for default policies). Defaults to true.
exclude_office_ips typing.Union[bool, cdktf.IResolvable] Whether to add Microsoft IPs to split tunnel exclusions.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#id ZeroTrustDeviceProfiles#id}.
match str Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
precedence typing.Union[int, float] The precedence of the policy. Lower values indicate higher precedence.
service_mode_v2_mode str The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
service_mode_v2_port typing.Union[int, float] The port to use for the proxy service mode. Required when using service_mode_v2_mode.
support_url str The support URL that will be opened when sending feedback.
switch_locked typing.Union[bool, cdktf.IResolvable] Enablement of the ZT client switch lock.
tunnel_protocol str Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.

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: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
  • Type: cdktf.ITerraformIterator

lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
  • Type: cdktf.TerraformProvider

provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

account_idRequired
  • Type: str

The account identifier to target for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#account_id ZeroTrustDeviceProfiles#account_id}


descriptionRequired
  • Type: str

Description of Policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#description ZeroTrustDeviceProfiles#description}


nameRequired
  • Type: str

Name of the policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#name ZeroTrustDeviceProfiles#name}


allowed_to_leaveOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to allow devices to leave the organization. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#allowed_to_leave ZeroTrustDeviceProfiles#allowed_to_leave}


allow_mode_switchOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to allow mode switch for this policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#allow_mode_switch ZeroTrustDeviceProfiles#allow_mode_switch}


allow_updatesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to allow updates under this policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#allow_updates ZeroTrustDeviceProfiles#allow_updates}


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

The amount of time in seconds to reconnect after having been disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#auto_connect ZeroTrustDeviceProfiles#auto_connect}


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

The captive portal value for this policy. Defaults to 180.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#captive_portal ZeroTrustDeviceProfiles#captive_portal}


defaultOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the policy refers to the default account policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#default ZeroTrustDeviceProfiles#default}


disable_auto_fallbackOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to disable auto fallback for this policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#disable_auto_fallback ZeroTrustDeviceProfiles#disable_auto_fallback}


enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the policy is enabled (cannot be set for default policies). Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#enabled ZeroTrustDeviceProfiles#enabled}


exclude_office_ipsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to add Microsoft IPs to split tunnel exclusions.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#exclude_office_ips ZeroTrustDeviceProfiles#exclude_office_ips}


idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#id ZeroTrustDeviceProfiles#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


matchOptional
  • Type: str

Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#match ZeroTrustDeviceProfiles#match}


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

The precedence of the policy. Lower values indicate higher precedence.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#precedence ZeroTrustDeviceProfiles#precedence}


service_mode_v2_modeOptional
  • Type: str

The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#service_mode_v2_mode ZeroTrustDeviceProfiles#service_mode_v2_mode}


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

The port to use for the proxy service mode. Required when using service_mode_v2_mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#service_mode_v2_port ZeroTrustDeviceProfiles#service_mode_v2_port}


support_urlOptional
  • Type: str

The support URL that will be opened when sending feedback.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#support_url ZeroTrustDeviceProfiles#support_url}


switch_lockedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Enablement of the ZT client switch lock.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#switch_locked ZeroTrustDeviceProfiles#switch_locked}


tunnel_protocolOptional
  • Type: str

Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#tunnel_protocol ZeroTrustDeviceProfiles#tunnel_protocol}


Methods

Name Description
to_string Returns a string representation of 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_allowed_to_leave No description.
reset_allow_mode_switch No description.
reset_allow_updates No description.
reset_auto_connect No description.
reset_captive_portal No description.
reset_default No description.
reset_disable_auto_fallback No description.
reset_enabled No description.
reset_exclude_office_ips No description.
reset_id No description.
reset_match No description.
reset_precedence No description.
reset_service_mode_v2_mode No description.
reset_service_mode_v2_port No description.
reset_support_url No description.
reset_switch_locked No description.
reset_tunnel_protocol No description.

to_string
def to_string() -> str

Returns a string representation of this construct.

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() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktf.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: typing.Union[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: typing.Union[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_allowed_to_leave
def reset_allowed_to_leave() -> None
reset_allow_mode_switch
def reset_allow_mode_switch() -> None
reset_allow_updates
def reset_allow_updates() -> None
reset_auto_connect
def reset_auto_connect() -> None
reset_captive_portal
def reset_captive_portal() -> None
reset_default
def reset_default() -> None
reset_disable_auto_fallback
def reset_disable_auto_fallback() -> None
reset_enabled
def reset_enabled() -> None
reset_exclude_office_ips
def reset_exclude_office_ips() -> None
reset_id
def reset_id() -> None
reset_match
def reset_match() -> None
reset_precedence
def reset_precedence() -> None
reset_service_mode_v2_mode
def reset_service_mode_v2_mode() -> None
reset_service_mode_v2_port
def reset_service_mode_v2_port() -> None
reset_support_url
def reset_support_url() -> None
reset_switch_locked
def reset_switch_locked() -> None
reset_tunnel_protocol
def reset_tunnel_protocol() -> 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 CDKTF code for importing a ZeroTrustDeviceProfiles resource upon running "cdktf plan ".

is_construct
from cdktf_cdktf_provider_cloudflare import zero_trust_device_profiles

zeroTrustDeviceProfiles.ZeroTrustDeviceProfiles.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 cdktf_cdktf_provider_cloudflare import zero_trust_device_profiles

zeroTrustDeviceProfiles.ZeroTrustDeviceProfiles.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktf_cdktf_provider_cloudflare import zero_trust_device_profiles

zeroTrustDeviceProfiles.ZeroTrustDeviceProfiles.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktf_cdktf_provider_cloudflare import zero_trust_device_profiles

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

Generates CDKTF code for importing a ZeroTrustDeviceProfiles resource upon running "cdktf 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 ZeroTrustDeviceProfiles to import.


import_from_idRequired
  • Type: str

The id of the existing ZeroTrustDeviceProfiles that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.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 cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
account_id_input str No description.
allowed_to_leave_input typing.Union[bool, cdktf.IResolvable] No description.
allow_mode_switch_input typing.Union[bool, cdktf.IResolvable] No description.
allow_updates_input typing.Union[bool, cdktf.IResolvable] No description.
auto_connect_input typing.Union[int, float] No description.
captive_portal_input typing.Union[int, float] No description.
default_input typing.Union[bool, cdktf.IResolvable] No description.
description_input str No description.
disable_auto_fallback_input typing.Union[bool, cdktf.IResolvable] No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
exclude_office_ips_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
match_input str No description.
name_input str No description.
precedence_input typing.Union[int, float] No description.
service_mode_v2_mode_input str No description.
service_mode_v2_port_input typing.Union[int, float] No description.
support_url_input str No description.
switch_locked_input typing.Union[bool, cdktf.IResolvable] No description.
tunnel_protocol_input str No description.
account_id str No description.
allowed_to_leave typing.Union[bool, cdktf.IResolvable] No description.
allow_mode_switch typing.Union[bool, cdktf.IResolvable] No description.
allow_updates typing.Union[bool, cdktf.IResolvable] No description.
auto_connect typing.Union[int, float] No description.
captive_portal typing.Union[int, float] No description.
default typing.Union[bool, cdktf.IResolvable] No description.
description str No description.
disable_auto_fallback typing.Union[bool, cdktf.IResolvable] No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
exclude_office_ips typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
match str No description.
name str No description.
precedence typing.Union[int, float] No description.
service_mode_v2_mode str No description.
service_mode_v2_port typing.Union[int, float] No description.
support_url str No description.
switch_locked typing.Union[bool, cdktf.IResolvable] No description.
tunnel_protocol str No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktf.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: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

provisionersOptional
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

account_id_inputOptional
account_id_input: str
  • Type: str

allowed_to_leave_inputOptional
allowed_to_leave_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

allow_mode_switch_inputOptional
allow_mode_switch_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

allow_updates_inputOptional
allow_updates_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

auto_connect_inputOptional
auto_connect_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

captive_portal_inputOptional
captive_portal_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

default_inputOptional
default_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

description_inputOptional
description_input: str
  • Type: str

disable_auto_fallback_inputOptional
disable_auto_fallback_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

enabled_inputOptional
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

exclude_office_ips_inputOptional
exclude_office_ips_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

id_inputOptional
id_input: str
  • Type: str

match_inputOptional
match_input: str
  • Type: str

name_inputOptional
name_input: str
  • Type: str

precedence_inputOptional
precedence_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

service_mode_v2_mode_inputOptional
service_mode_v2_mode_input: str
  • Type: str

service_mode_v2_port_inputOptional
service_mode_v2_port_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

support_url_inputOptional
support_url_input: str
  • Type: str

switch_locked_inputOptional
switch_locked_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

tunnel_protocol_inputOptional
tunnel_protocol_input: str
  • Type: str

account_idRequired
account_id: str
  • Type: str

allowed_to_leaveRequired
allowed_to_leave: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

allow_mode_switchRequired
allow_mode_switch: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

allow_updatesRequired
allow_updates: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

auto_connectRequired
auto_connect: typing.Union[int, float]
  • Type: typing.Union[int, float]

captive_portalRequired
captive_portal: typing.Union[int, float]
  • Type: typing.Union[int, float]

defaultRequired
default: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

descriptionRequired
description: str
  • Type: str

disable_auto_fallbackRequired
disable_auto_fallback: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

enabledRequired
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

exclude_office_ipsRequired
exclude_office_ips: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

idRequired
id: str
  • Type: str

matchRequired
match: str
  • Type: str

nameRequired
name: str
  • Type: str

precedenceRequired
precedence: typing.Union[int, float]
  • Type: typing.Union[int, float]

service_mode_v2_modeRequired
service_mode_v2_mode: str
  • Type: str

service_mode_v2_portRequired
service_mode_v2_port: typing.Union[int, float]
  • Type: typing.Union[int, float]

support_urlRequired
support_url: str
  • Type: str

switch_lockedRequired
switch_locked: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

tunnel_protocolRequired
tunnel_protocol: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

ZeroTrustDeviceProfilesConfig

Initializer

from cdktf_cdktf_provider_cloudflare import zero_trust_device_profiles

zeroTrustDeviceProfiles.ZeroTrustDeviceProfilesConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  account_id: str,
  description: str,
  name: str,
  allowed_to_leave: typing.Union[bool, IResolvable] = None,
  allow_mode_switch: typing.Union[bool, IResolvable] = None,
  allow_updates: typing.Union[bool, IResolvable] = None,
  auto_connect: typing.Union[int, float] = None,
  captive_portal: typing.Union[int, float] = None,
  default: typing.Union[bool, IResolvable] = None,
  disable_auto_fallback: typing.Union[bool, IResolvable] = None,
  enabled: typing.Union[bool, IResolvable] = None,
  exclude_office_ips: typing.Union[bool, IResolvable] = None,
  id: str = None,
  match: str = None,
  precedence: typing.Union[int, float] = None,
  service_mode_v2_mode: str = None,
  service_mode_v2_port: typing.Union[int, float] = None,
  support_url: str = None,
  switch_locked: typing.Union[bool, IResolvable] = None,
  tunnel_protocol: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
account_id str The account identifier to target for the resource.
description str Description of Policy.
name str Name of the policy.
allowed_to_leave typing.Union[bool, cdktf.IResolvable] Whether to allow devices to leave the organization. Defaults to true.
allow_mode_switch typing.Union[bool, cdktf.IResolvable] Whether to allow mode switch for this policy.
allow_updates typing.Union[bool, cdktf.IResolvable] Whether to allow updates under this policy.
auto_connect typing.Union[int, float] The amount of time in seconds to reconnect after having been disabled.
captive_portal typing.Union[int, float] The captive portal value for this policy. Defaults to 180.
default typing.Union[bool, cdktf.IResolvable] Whether the policy refers to the default account policy.
disable_auto_fallback typing.Union[bool, cdktf.IResolvable] Whether to disable auto fallback for this policy.
enabled typing.Union[bool, cdktf.IResolvable] Whether the policy is enabled (cannot be set for default policies). Defaults to true.
exclude_office_ips typing.Union[bool, cdktf.IResolvable] Whether to add Microsoft IPs to split tunnel exclusions.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#id ZeroTrustDeviceProfiles#id}.
match str Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
precedence typing.Union[int, float] The precedence of the policy. Lower values indicate higher precedence.
service_mode_v2_mode str The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
service_mode_v2_port typing.Union[int, float] The port to use for the proxy service mode. Required when using service_mode_v2_mode.
support_url str The support URL that will be opened when sending feedback.
switch_locked typing.Union[bool, cdktf.IResolvable] Enablement of the ZT client switch lock.
tunnel_protocol str Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

provisionersOptional
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

account_idRequired
account_id: str
  • Type: str

The account identifier to target for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#account_id ZeroTrustDeviceProfiles#account_id}


descriptionRequired
description: str
  • Type: str

Description of Policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#description ZeroTrustDeviceProfiles#description}


nameRequired
name: str
  • Type: str

Name of the policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#name ZeroTrustDeviceProfiles#name}


allowed_to_leaveOptional
allowed_to_leave: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to allow devices to leave the organization. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#allowed_to_leave ZeroTrustDeviceProfiles#allowed_to_leave}


allow_mode_switchOptional
allow_mode_switch: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to allow mode switch for this policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#allow_mode_switch ZeroTrustDeviceProfiles#allow_mode_switch}


allow_updatesOptional
allow_updates: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to allow updates under this policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#allow_updates ZeroTrustDeviceProfiles#allow_updates}


auto_connectOptional
auto_connect: typing.Union[int, float]
  • Type: typing.Union[int, float]

The amount of time in seconds to reconnect after having been disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#auto_connect ZeroTrustDeviceProfiles#auto_connect}


captive_portalOptional
captive_portal: typing.Union[int, float]
  • Type: typing.Union[int, float]

The captive portal value for this policy. Defaults to 180.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#captive_portal ZeroTrustDeviceProfiles#captive_portal}


defaultOptional
default: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the policy refers to the default account policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#default ZeroTrustDeviceProfiles#default}


disable_auto_fallbackOptional
disable_auto_fallback: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to disable auto fallback for this policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#disable_auto_fallback ZeroTrustDeviceProfiles#disable_auto_fallback}


enabledOptional
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the policy is enabled (cannot be set for default policies). Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#enabled ZeroTrustDeviceProfiles#enabled}


exclude_office_ipsOptional
exclude_office_ips: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether to add Microsoft IPs to split tunnel exclusions.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#exclude_office_ips ZeroTrustDeviceProfiles#exclude_office_ips}


idOptional
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#id ZeroTrustDeviceProfiles#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


matchOptional
match: str
  • Type: str

Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#match ZeroTrustDeviceProfiles#match}


precedenceOptional
precedence: typing.Union[int, float]
  • Type: typing.Union[int, float]

The precedence of the policy. Lower values indicate higher precedence.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#precedence ZeroTrustDeviceProfiles#precedence}


service_mode_v2_modeOptional
service_mode_v2_mode: str
  • Type: str

The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#service_mode_v2_mode ZeroTrustDeviceProfiles#service_mode_v2_mode}


service_mode_v2_portOptional
service_mode_v2_port: typing.Union[int, float]
  • Type: typing.Union[int, float]

The port to use for the proxy service mode. Required when using service_mode_v2_mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#service_mode_v2_port ZeroTrustDeviceProfiles#service_mode_v2_port}


support_urlOptional
support_url: str
  • Type: str

The support URL that will be opened when sending feedback.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#support_url ZeroTrustDeviceProfiles#support_url}


switch_lockedOptional
switch_locked: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Enablement of the ZT client switch lock.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#switch_locked ZeroTrustDeviceProfiles#switch_locked}


tunnel_protocolOptional
tunnel_protocol: str
  • Type: str

Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_device_profiles#tunnel_protocol ZeroTrustDeviceProfiles#tunnel_protocol}