Skip to content

Latest commit

 

History

History
2976 lines (1888 loc) · 146 KB

zeroTrustAccessOrganization.python.md

File metadata and controls

2976 lines (1888 loc) · 146 KB

zeroTrustAccessOrganization Submodule

Constructs

ZeroTrustAccessOrganization

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

Initializers 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganization(
  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,
  auth_domain: str,
  name: str,
  account_id: str = None,
  allow_authenticate_via_warp: typing.Union[bool, IResolvable] = None,
  auto_redirect_to_identity: typing.Union[bool, IResolvable] = None,
  custom_pages: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]] = None,
  id: str = None,
  is_ui_read_only: typing.Union[bool, IResolvable] = None,
  login_design: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]] = None,
  session_duration: str = None,
  ui_read_only_toggle_reason: str = None,
  user_seat_expiration_inactive_time: str = None,
  warp_auth_session_duration: str = None,
  zone_id: 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.
auth_domain str The unique subdomain assigned to your Zero Trust organization.
name str The name of your Zero Trust organization.
account_id str The account identifier to target for the resource. Conflicts with zone_id.
allow_authenticate_via_warp typing.Union[bool, cdktf.IResolvable] When set to true, users can authenticate via WARP for any application in your organization.
auto_redirect_to_identity typing.Union[bool, cdktf.IResolvable] When set to true, users skip the identity provider selection step during login.
custom_pages typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]] custom_pages block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#id ZeroTrustAccessOrganization#id}.
is_ui_read_only typing.Union[bool, cdktf.IResolvable] When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.
login_design typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]] login_design block.
session_duration str How often a user will be forced to re-authorise. Must be in the format 48h or 2h45m.
ui_read_only_toggle_reason str A description of the reason why the UI read only field is being toggled.
user_seat_expiration_inactive_time str The amount of time a user seat is inactive before it expires.
warp_auth_session_duration str The amount of time that tokens issued for applications will be valid.
zone_id str The zone identifier to target for the resource. Conflicts with account_id.
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]]
auth_domainRequired
  • Type: str

The unique subdomain assigned to your Zero Trust organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#auth_domain ZeroTrustAccessOrganization#auth_domain}

nameRequired
  • Type: str

The name of your Zero Trust organization.

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

account_idOptional
  • Type: str

The account identifier to target for the resource. Conflicts with zone_id.

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

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

When set to true, users can authenticate via WARP for any application in your organization.

Application settings will take precedence over this value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#allow_authenticate_via_warp ZeroTrustAccessOrganization#allow_authenticate_via_warp}

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

When set to true, users skip the identity provider selection step during login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#auto_redirect_to_identity ZeroTrustAccessOrganization#auto_redirect_to_identity}

custom_pagesOptional

custom_pages block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#custom_pages ZeroTrustAccessOrganization#custom_pages}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#id ZeroTrustAccessOrganization#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.

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

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#is_ui_read_only ZeroTrustAccessOrganization#is_ui_read_only}

login_designOptional

login_design block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#login_design ZeroTrustAccessOrganization#login_design}

session_durationOptional
  • Type: str

How often a user will be forced to re-authorise. Must be in the format 48h or 2h45m.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#session_duration ZeroTrustAccessOrganization#session_duration}

ui_read_only_toggle_reasonOptional
  • Type: str

A description of the reason why the UI read only field is being toggled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#ui_read_only_toggle_reason ZeroTrustAccessOrganization#ui_read_only_toggle_reason}

user_seat_expiration_inactive_timeOptional
  • Type: str

The amount of time a user seat is inactive before it expires.

When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format 300ms or 2h45m.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#user_seat_expiration_inactive_time ZeroTrustAccessOrganization#user_seat_expiration_inactive_time}

warp_auth_session_durationOptional
  • Type: str

The amount of time that tokens issued for applications will be valid.

Must be in the format 30m or 2h45m. Valid time units are: m, h.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#warp_auth_session_duration ZeroTrustAccessOrganization#warp_auth_session_duration}

zone_idOptional
  • Type: str

The zone identifier to target for the resource. Conflicts with account_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#zone_id ZeroTrustAccessOrganization#zone_id}

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".
put_custom_pages No description.
put_login_design No description.
reset_account_id No description.
reset_allow_authenticate_via_warp No description.
reset_auto_redirect_to_identity No description.
reset_custom_pages No description.
reset_id No description.
reset_is_ui_read_only No description.
reset_login_design No description.
reset_session_duration No description.
reset_ui_read_only_toggle_reason No description.
reset_user_seat_expiration_inactive_time No description.
reset_warp_auth_session_duration No description.
reset_zone_id 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".

put_custom_pages 
def put_custom_pages(
  value: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]]
) -> None
valueRequired
put_login_design 
def put_login_design(
  value: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]]
) -> None
valueRequired
reset_account_id 
def reset_account_id() -> None
reset_allow_authenticate_via_warp 
def reset_allow_authenticate_via_warp() -> None
reset_auto_redirect_to_identity 
def reset_auto_redirect_to_identity() -> None
reset_custom_pages 
def reset_custom_pages() -> None
reset_id 
def reset_id() -> None
reset_is_ui_read_only 
def reset_is_ui_read_only() -> None
reset_login_design 
def reset_login_design() -> None
reset_session_duration 
def reset_session_duration() -> None
reset_ui_read_only_toggle_reason 
def reset_ui_read_only_toggle_reason() -> None
reset_user_seat_expiration_inactive_time 
def reset_user_seat_expiration_inactive_time() -> None
reset_warp_auth_session_duration 
def reset_warp_auth_session_duration() -> None
reset_zone_id 
def reset_zone_id() -> 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 ZeroTrustAccessOrganization resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganization.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_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganization.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganization.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

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

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

import_from_idRequired
  • Type: str

The id of the existing ZeroTrustAccessOrganization that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#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 ZeroTrustAccessOrganization 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.
custom_pages ZeroTrustAccessOrganizationCustomPagesList No description.
login_design ZeroTrustAccessOrganizationLoginDesignList No description.
account_id_input str No description.
allow_authenticate_via_warp_input typing.Union[bool, cdktf.IResolvable] No description.
auth_domain_input str No description.
auto_redirect_to_identity_input typing.Union[bool, cdktf.IResolvable] No description.
custom_pages_input typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]] No description.
id_input str No description.
is_ui_read_only_input typing.Union[bool, cdktf.IResolvable] No description.
login_design_input typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]] No description.
name_input str No description.
session_duration_input str No description.
ui_read_only_toggle_reason_input str No description.
user_seat_expiration_inactive_time_input str No description.
warp_auth_session_duration_input str No description.
zone_id_input str No description.
account_id str No description.
allow_authenticate_via_warp typing.Union[bool, cdktf.IResolvable] No description.
auth_domain str No description.
auto_redirect_to_identity typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
is_ui_read_only typing.Union[bool, cdktf.IResolvable] No description.
name str No description.
session_duration str No description.
ui_read_only_toggle_reason str No description.
user_seat_expiration_inactive_time str No description.
warp_auth_session_duration str No description.
zone_id 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]]
custom_pagesRequired 
custom_pages: ZeroTrustAccessOrganizationCustomPagesList
login_designRequired 
login_design: ZeroTrustAccessOrganizationLoginDesignList
account_id_inputOptional 
account_id_input: str
  • Type: str
allow_authenticate_via_warp_inputOptional 
allow_authenticate_via_warp_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
auth_domain_inputOptional 
auth_domain_input: str
  • Type: str
auto_redirect_to_identity_inputOptional 
auto_redirect_to_identity_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
custom_pages_inputOptional 
custom_pages_input: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]]
id_inputOptional 
id_input: str
  • Type: str
is_ui_read_only_inputOptional 
is_ui_read_only_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
login_design_inputOptional 
login_design_input: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]]
name_inputOptional 
name_input: str
  • Type: str
session_duration_inputOptional 
session_duration_input: str
  • Type: str
ui_read_only_toggle_reason_inputOptional 
ui_read_only_toggle_reason_input: str
  • Type: str
user_seat_expiration_inactive_time_inputOptional 
user_seat_expiration_inactive_time_input: str
  • Type: str
warp_auth_session_duration_inputOptional 
warp_auth_session_duration_input: str
  • Type: str
zone_id_inputOptional 
zone_id_input: str
  • Type: str
account_idRequired 
account_id: str
  • Type: str
allow_authenticate_via_warpRequired 
allow_authenticate_via_warp: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
auth_domainRequired 
auth_domain: str
  • Type: str
auto_redirect_to_identityRequired 
auto_redirect_to_identity: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
is_ui_read_onlyRequired 
is_ui_read_only: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
nameRequired 
name: str
  • Type: str
session_durationRequired 
session_duration: str
  • Type: str
ui_read_only_toggle_reasonRequired 
ui_read_only_toggle_reason: str
  • Type: str
user_seat_expiration_inactive_timeRequired 
user_seat_expiration_inactive_time: str
  • Type: str
warp_auth_session_durationRequired 
warp_auth_session_duration: str
  • Type: str
zone_idRequired 
zone_id: str
  • Type: str

Constants

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

Structs

ZeroTrustAccessOrganizationConfig

Initializer 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationConfig(
  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,
  auth_domain: str,
  name: str,
  account_id: str = None,
  allow_authenticate_via_warp: typing.Union[bool, IResolvable] = None,
  auto_redirect_to_identity: typing.Union[bool, IResolvable] = None,
  custom_pages: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]] = None,
  id: str = None,
  is_ui_read_only: typing.Union[bool, IResolvable] = None,
  login_design: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]] = None,
  session_duration: str = None,
  ui_read_only_toggle_reason: str = None,
  user_seat_expiration_inactive_time: str = None,
  warp_auth_session_duration: str = None,
  zone_id: 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.
auth_domain str The unique subdomain assigned to your Zero Trust organization.
name str The name of your Zero Trust organization.
account_id str The account identifier to target for the resource. Conflicts with zone_id.
allow_authenticate_via_warp typing.Union[bool, cdktf.IResolvable] When set to true, users can authenticate via WARP for any application in your organization.
auto_redirect_to_identity typing.Union[bool, cdktf.IResolvable] When set to true, users skip the identity provider selection step during login.
custom_pages typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]] custom_pages block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#id ZeroTrustAccessOrganization#id}.
is_ui_read_only typing.Union[bool, cdktf.IResolvable] When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.
login_design typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]] login_design block.
session_duration str How often a user will be forced to re-authorise. Must be in the format 48h or 2h45m.
ui_read_only_toggle_reason str A description of the reason why the UI read only field is being toggled.
user_seat_expiration_inactive_time str The amount of time a user seat is inactive before it expires.
warp_auth_session_duration str The amount of time that tokens issued for applications will be valid.
zone_id str The zone identifier to target for the resource. Conflicts with account_id.
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]]
auth_domainRequired 
auth_domain: str
  • Type: str

The unique subdomain assigned to your Zero Trust organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#auth_domain ZeroTrustAccessOrganization#auth_domain}

nameRequired 
name: str
  • Type: str

The name of your Zero Trust organization.

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

account_idOptional 
account_id: str
  • Type: str

The account identifier to target for the resource. Conflicts with zone_id.

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

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

When set to true, users can authenticate via WARP for any application in your organization.

Application settings will take precedence over this value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#allow_authenticate_via_warp ZeroTrustAccessOrganization#allow_authenticate_via_warp}

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

When set to true, users skip the identity provider selection step during login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#auto_redirect_to_identity ZeroTrustAccessOrganization#auto_redirect_to_identity}

custom_pagesOptional 
custom_pages: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]]

custom_pages block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#custom_pages ZeroTrustAccessOrganization#custom_pages}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#id ZeroTrustAccessOrganization#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.

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

When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#is_ui_read_only ZeroTrustAccessOrganization#is_ui_read_only}

login_designOptional 
login_design: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]]

login_design block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#login_design ZeroTrustAccessOrganization#login_design}

session_durationOptional 
session_duration: str
  • Type: str

How often a user will be forced to re-authorise. Must be in the format 48h or 2h45m.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#session_duration ZeroTrustAccessOrganization#session_duration}

ui_read_only_toggle_reasonOptional 
ui_read_only_toggle_reason: str
  • Type: str

A description of the reason why the UI read only field is being toggled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#ui_read_only_toggle_reason ZeroTrustAccessOrganization#ui_read_only_toggle_reason}

user_seat_expiration_inactive_timeOptional 
user_seat_expiration_inactive_time: str
  • Type: str

The amount of time a user seat is inactive before it expires.

When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format 300ms or 2h45m.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#user_seat_expiration_inactive_time ZeroTrustAccessOrganization#user_seat_expiration_inactive_time}

warp_auth_session_durationOptional 
warp_auth_session_duration: str
  • Type: str

The amount of time that tokens issued for applications will be valid.

Must be in the format 30m or 2h45m. Valid time units are: m, h.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#warp_auth_session_duration ZeroTrustAccessOrganization#warp_auth_session_duration}

zone_idOptional 
zone_id: str
  • Type: str

The zone identifier to target for the resource. Conflicts with account_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#zone_id ZeroTrustAccessOrganization#zone_id}

ZeroTrustAccessOrganizationCustomPages

Initializer 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationCustomPages(
  forbidden: str = None,
  identity_denied: str = None
)

Properties

Name Type Description
forbidden str The id of the forbidden page.
identity_denied str The id of the identity denied page.
forbiddenOptional 
forbidden: str
  • Type: str

The id of the forbidden page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#forbidden ZeroTrustAccessOrganization#forbidden}

identity_deniedOptional 
identity_denied: str
  • Type: str

The id of the identity denied page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#identity_denied ZeroTrustAccessOrganization#identity_denied}

ZeroTrustAccessOrganizationLoginDesign

Initializer 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationLoginDesign(
  background_color: str = None,
  footer_text: str = None,
  header_text: str = None,
  logo_path: str = None,
  text_color: str = None
)

Properties

Name Type Description
background_color str The background color on the login page.
footer_text str The text at the bottom of the login page.
header_text str The text at the top of the login page.
logo_path str The URL of the logo on the login page.
text_color str The text color on the login page.
background_colorOptional 
background_color: str
  • Type: str

The background color on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#background_color ZeroTrustAccessOrganization#background_color}

footer_textOptional 
footer_text: str
  • Type: str

The text at the bottom of the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#footer_text ZeroTrustAccessOrganization#footer_text}

header_textOptional 
header_text: str
  • Type: str

The text at the top of the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#header_text ZeroTrustAccessOrganization#header_text}

logo_pathOptional 
logo_path: str
  • Type: str

The URL of the logo on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#logo_path ZeroTrustAccessOrganization#logo_path}

text_colorOptional 
text_color: str
  • Type: str

The text color on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.51.0/docs/resources/zero_trust_access_organization#text_color ZeroTrustAccessOrganization#text_color}

Classes

ZeroTrustAccessOrganizationCustomPagesList

Initializers 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationCustomPagesList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> ZeroTrustAccessOrganizationCustomPagesOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

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.
internal_value typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]] 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
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationCustomPages]]

ZeroTrustAccessOrganizationCustomPagesOutputReference

Initializers 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationCustomPagesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_forbidden 
def reset_forbidden() -> None
reset_identity_denied 
def reset_identity_denied() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
forbidden_input str No description.
identity_denied_input str No description.
forbidden str No description.
identity_denied str No description.
internal_value typing.Union[cdktf.IResolvable, ZeroTrustAccessOrganizationCustomPages] 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
forbidden_inputOptional 
forbidden_input: str
  • Type: str
identity_denied_inputOptional 
identity_denied_input: str
  • Type: str
forbiddenRequired 
forbidden: str
  • Type: str
identity_deniedRequired 
identity_denied: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, ZeroTrustAccessOrganizationCustomPages]

ZeroTrustAccessOrganizationLoginDesignList

Initializers 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationLoginDesignList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> ZeroTrustAccessOrganizationLoginDesignOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

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.
internal_value typing.Union[cdktf.IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]] 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
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[ZeroTrustAccessOrganizationLoginDesign]]

ZeroTrustAccessOrganizationLoginDesignOutputReference

Initializers 

from cdktf_cdktf_provider_cloudflare import zero_trust_access_organization

zeroTrustAccessOrganization.ZeroTrustAccessOrganizationLoginDesignOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_background_color 
def reset_background_color() -> None
reset_footer_text 
def reset_footer_text() -> None
reset_header_text 
def reset_header_text() -> None
reset_logo_path 
def reset_logo_path() -> None
reset_text_color 
def reset_text_color() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
background_color_input str No description.
footer_text_input str No description.
header_text_input str No description.
logo_path_input str No description.
text_color_input str No description.
background_color str No description.
footer_text str No description.
header_text str No description.
logo_path str No description.
text_color str No description.
internal_value typing.Union[cdktf.IResolvable, ZeroTrustAccessOrganizationLoginDesign] 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
background_color_inputOptional 
background_color_input: str
  • Type: str
footer_text_inputOptional 
footer_text_input: str
  • Type: str
header_text_inputOptional 
header_text_input: str
  • Type: str
logo_path_inputOptional 
logo_path_input: str
  • Type: str
text_color_inputOptional 
text_color_input: str
  • Type: str
background_colorRequired 
background_color: str
  • Type: str
footer_textRequired 
footer_text: str
  • Type: str
header_textRequired 
header_text: str
  • Type: str
logo_pathRequired 
logo_path: str
  • Type: str
text_colorRequired 
text_color: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, ZeroTrustAccessOrganizationLoginDesign]