`accessOrganization` Submodule

Constructs

AccessOrganization

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization cloudflare_access_organization}.

Initializers

import { accessOrganization } from '@cdktf/provider-cloudflare'

new accessOrganization.AccessOrganization(scope: Construct, id: string, config: AccessOrganizationConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`AccessOrganizationConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: AccessOrganizationConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putCustomPages`	No description.
`putLoginDesign`	No description.
`resetAccountId`	No description.
`resetAllowAuthenticateViaWarp`	No description.
`resetAutoRedirectToIdentity`	No description.
`resetCustomPages`	No description.
`resetId`	No description.
`resetIsUiReadOnly`	No description.
`resetLoginDesign`	No description.
`resetName`	No description.
`resetSessionDuration`	No description.
`resetUiReadOnlyToggleReason`	No description.
`resetUserSeatExpirationInactiveTime`	No description.
`resetWarpAuthSessionDuration`	No description.
`resetZoneId`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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.

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putCustomPages`

public putCustomPages(value: IResolvable | AccessOrganizationCustomPages[]): void

`value`^Required

Type: cdktf.IResolvable | AccessOrganizationCustomPages[]

`putLoginDesign`

public putLoginDesign(value: IResolvable | AccessOrganizationLoginDesign[]): void

`value`^Required

Type: cdktf.IResolvable | AccessOrganizationLoginDesign[]

`resetAccountId`

public resetAccountId(): void

`resetAllowAuthenticateViaWarp`

public resetAllowAuthenticateViaWarp(): void

`resetAutoRedirectToIdentity`

public resetAutoRedirectToIdentity(): void

`resetCustomPages`

public resetCustomPages(): void

`resetId`

public resetId(): void

`resetIsUiReadOnly`

public resetIsUiReadOnly(): void

`resetLoginDesign`

public resetLoginDesign(): void

`resetName`

public resetName(): void

`resetSessionDuration`

public resetSessionDuration(): void

`resetUiReadOnlyToggleReason`

public resetUiReadOnlyToggleReason(): void

`resetUserSeatExpirationInactiveTime`

public resetUserSeatExpirationInactiveTime(): void

`resetWarpAuthSessionDuration`

public resetWarpAuthSessionDuration(): void

`resetZoneId`

public resetZoneId(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a AccessOrganization resource upon running "cdktf plan ".

`isConstruct`

import { accessOrganization } from '@cdktf/provider-cloudflare'

accessOrganization.AccessOrganization.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { accessOrganization } from '@cdktf/provider-cloudflare'

accessOrganization.AccessOrganization.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { accessOrganization } from '@cdktf/provider-cloudflare'

accessOrganization.AccessOrganization.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { accessOrganization } from '@cdktf/provider-cloudflare'

accessOrganization.AccessOrganization.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a AccessOrganization resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing AccessOrganization that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`customPages`	`AccessOrganizationCustomPagesList`	No description.
`loginDesign`	`AccessOrganizationLoginDesignList`	No description.
`accountIdInput`	`string`	No description.
`allowAuthenticateViaWarpInput`	`boolean \| cdktf.IResolvable`	No description.
`authDomainInput`	`string`	No description.
`autoRedirectToIdentityInput`	`boolean \| cdktf.IResolvable`	No description.
`customPagesInput`	`cdktf.IResolvable \| AccessOrganizationCustomPages[]`	No description.
`idInput`	`string`	No description.
`isUiReadOnlyInput`	`boolean \| cdktf.IResolvable`	No description.
`loginDesignInput`	`cdktf.IResolvable \| AccessOrganizationLoginDesign[]`	No description.
`nameInput`	`string`	No description.
`sessionDurationInput`	`string`	No description.
`uiReadOnlyToggleReasonInput`	`string`	No description.
`userSeatExpirationInactiveTimeInput`	`string`	No description.
`warpAuthSessionDurationInput`	`string`	No description.
`zoneIdInput`	`string`	No description.
`accountId`	`string`	No description.
`allowAuthenticateViaWarp`	`boolean \| cdktf.IResolvable`	No description.
`authDomain`	`string`	No description.
`autoRedirectToIdentity`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`isUiReadOnly`	`boolean \| cdktf.IResolvable`	No description.
`name`	`string`	No description.
`sessionDuration`	`string`	No description.
`uiReadOnlyToggleReason`	`string`	No description.
`userSeatExpirationInactiveTime`	`string`	No description.
`warpAuthSessionDuration`	`string`	No description.
`zoneId`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`customPages`^Required

public readonly customPages: AccessOrganizationCustomPagesList;

Type: AccessOrganizationCustomPagesList

`loginDesign`^Required

public readonly loginDesign: AccessOrganizationLoginDesignList;

Type: AccessOrganizationLoginDesignList

`accountIdInput`^Optional

public readonly accountIdInput: string;

Type: string

`allowAuthenticateViaWarpInput`^Optional

public readonly allowAuthenticateViaWarpInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`authDomainInput`^Optional

public readonly authDomainInput: string;

Type: string

`autoRedirectToIdentityInput`^Optional

public readonly autoRedirectToIdentityInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`customPagesInput`^Optional

public readonly customPagesInput: IResolvable | AccessOrganizationCustomPages[];

Type: cdktf.IResolvable | AccessOrganizationCustomPages[]

`idInput`^Optional

public readonly idInput: string;

Type: string

`isUiReadOnlyInput`^Optional

public readonly isUiReadOnlyInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`loginDesignInput`^Optional

public readonly loginDesignInput: IResolvable | AccessOrganizationLoginDesign[];

Type: cdktf.IResolvable | AccessOrganizationLoginDesign[]

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`sessionDurationInput`^Optional

public readonly sessionDurationInput: string;

Type: string

`uiReadOnlyToggleReasonInput`^Optional

public readonly uiReadOnlyToggleReasonInput: string;

Type: string

`userSeatExpirationInactiveTimeInput`^Optional

public readonly userSeatExpirationInactiveTimeInput: string;

Type: string

`warpAuthSessionDurationInput`^Optional

public readonly warpAuthSessionDurationInput: string;

Type: string

`zoneIdInput`^Optional

public readonly zoneIdInput: string;

Type: string

`accountId`^Required

public readonly accountId: string;

Type: string

`allowAuthenticateViaWarp`^Required

public readonly allowAuthenticateViaWarp: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`authDomain`^Required

public readonly authDomain: string;

Type: string

`autoRedirectToIdentity`^Required

public readonly autoRedirectToIdentity: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`isUiReadOnly`^Required

public readonly isUiReadOnly: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`name`^Required

public readonly name: string;

Type: string

`sessionDuration`^Required

public readonly sessionDuration: string;

Type: string

`uiReadOnlyToggleReason`^Required

public readonly uiReadOnlyToggleReason: string;

Type: string

`userSeatExpirationInactiveTime`^Required

public readonly userSeatExpirationInactiveTime: string;

Type: string

`warpAuthSessionDuration`^Required

public readonly warpAuthSessionDuration: string;

Type: string

`zoneId`^Required

public readonly zoneId: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

AccessOrganizationConfig

Initializer

import { accessOrganization } from '@cdktf/provider-cloudflare'

const accessOrganizationConfig: accessOrganization.AccessOrganizationConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`authDomain`	`string`	The unique subdomain assigned to your Zero Trust organization.
`accountId`	`string`	The account identifier to target for the resource. Conflicts with `zone_id`.
`allowAuthenticateViaWarp`	`boolean \| cdktf.IResolvable`	When set to true, users can authenticate via WARP for any application in your organization.
`autoRedirectToIdentity`	`boolean \| cdktf.IResolvable`	When set to true, users skip the identity provider selection step during login.
`customPages`	`cdktf.IResolvable \| AccessOrganizationCustomPages[]`	custom_pages block.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#id AccessOrganization#id}.
`isUiReadOnly`	`boolean \| cdktf.IResolvable`	When set to true, this will disable all editing of Access resources via the Zero Trust Dashboard.
`loginDesign`	`cdktf.IResolvable \| AccessOrganizationLoginDesign[]`	login_design block.
`name`	`string`	The name of your Zero Trust organization.
`sessionDuration`	`string`	How often a user will be forced to re-authorise. Must be in the format `48h` or `2h45m`.
`uiReadOnlyToggleReason`	`string`	A description of the reason why the UI read only field is being toggled.
`userSeatExpirationInactiveTime`	`string`	The amount of time a user seat is inactive before it expires.
`warpAuthSessionDuration`	`string`	The amount of time that tokens issued for applications will be valid.
`zoneId`	`string`	The zone identifier to target for the resource. Conflicts with `account_id`.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`authDomain`^Required

public readonly authDomain: string;

Type: string

The unique subdomain assigned to your Zero Trust organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#auth_domain AccessOrganization#auth_domain}

`accountId`^Optional

public readonly accountId: string;

Type: string

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.34.0/docs/resources/access_organization#account_id AccessOrganization#account_id}

`allowAuthenticateViaWarp`^Optional

public readonly allowAuthenticateViaWarp: boolean | IResolvable;

Type: boolean | 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.34.0/docs/resources/access_organization#allow_authenticate_via_warp AccessOrganization#allow_authenticate_via_warp}

`autoRedirectToIdentity`^Optional

public readonly autoRedirectToIdentity: boolean | IResolvable;

Type: boolean | 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.34.0/docs/resources/access_organization#auto_redirect_to_identity AccessOrganization#auto_redirect_to_identity}

`customPages`^Optional

public readonly customPages: IResolvable | AccessOrganizationCustomPages[];

Type: cdktf.IResolvable | AccessOrganizationCustomPages[]

custom_pages block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#custom_pages AccessOrganization#custom_pages}

`id`^Optional

public readonly id: string;

Type: string

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

`isUiReadOnly`^Optional

public readonly isUiReadOnly: boolean | IResolvable;

Type: boolean | 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.34.0/docs/resources/access_organization#is_ui_read_only AccessOrganization#is_ui_read_only}

`loginDesign`^Optional

public readonly loginDesign: IResolvable | AccessOrganizationLoginDesign[];

Type: cdktf.IResolvable | AccessOrganizationLoginDesign[]

login_design block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#login_design AccessOrganization#login_design}

`name`^Optional

public readonly name: string;

Type: string

The name of your Zero Trust organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#name AccessOrganization#name}

`sessionDuration`^Optional

public readonly sessionDuration: string;

Type: string

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.34.0/docs/resources/access_organization#session_duration AccessOrganization#session_duration}

`uiReadOnlyToggleReason`^Optional

public readonly uiReadOnlyToggleReason: string;

Type: string

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.34.0/docs/resources/access_organization#ui_read_only_toggle_reason AccessOrganization#ui_read_only_toggle_reason}

`userSeatExpirationInactiveTime`^Optional

public readonly userSeatExpirationInactiveTime: string;

Type: string

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.34.0/docs/resources/access_organization#user_seat_expiration_inactive_time AccessOrganization#user_seat_expiration_inactive_time}

`warpAuthSessionDuration`^Optional

public readonly warpAuthSessionDuration: string;

Type: string

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.34.0/docs/resources/access_organization#warp_auth_session_duration AccessOrganization#warp_auth_session_duration}

`zoneId`^Optional

public readonly zoneId: string;

Type: string

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.34.0/docs/resources/access_organization#zone_id AccessOrganization#zone_id}

AccessOrganizationCustomPages

Initializer

import { accessOrganization } from '@cdktf/provider-cloudflare'

const accessOrganizationCustomPages: accessOrganization.AccessOrganizationCustomPages = { ... }

Properties

Name	Type	Description
`forbidden`	`string`	The id of the forbidden page.
`identityDenied`	`string`	The id of the identity denied page.

`forbidden`^Optional

public readonly forbidden: string;

Type: string

The id of the forbidden page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#forbidden AccessOrganization#forbidden}

`identityDenied`^Optional

public readonly identityDenied: string;

Type: string

The id of the identity denied page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#identity_denied AccessOrganization#identity_denied}

AccessOrganizationLoginDesign

Initializer

import { accessOrganization } from '@cdktf/provider-cloudflare'

const accessOrganizationLoginDesign: accessOrganization.AccessOrganizationLoginDesign = { ... }

Properties

Name	Type	Description
`backgroundColor`	`string`	The background color on the login page.
`footerText`	`string`	The text at the bottom of the login page.
`headerText`	`string`	The text at the top of the login page.
`logoPath`	`string`	The URL of the logo on the login page.
`textColor`	`string`	The text color on the login page.

`backgroundColor`^Optional

public readonly backgroundColor: string;

Type: string

The background color on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#background_color AccessOrganization#background_color}

`footerText`^Optional

public readonly footerText: string;

Type: string

The text at the bottom of the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#footer_text AccessOrganization#footer_text}

`headerText`^Optional

public readonly headerText: string;

Type: string

The text at the top of the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#header_text AccessOrganization#header_text}

`logoPath`^Optional

public readonly logoPath: string;

Type: string

The URL of the logo on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#logo_path AccessOrganization#logo_path}

`textColor`^Optional

public readonly textColor: string;

Type: string

The text color on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/access_organization#text_color AccessOrganization#text_color}

Classes

AccessOrganizationCustomPagesList

Initializers

import { accessOrganization } from '@cdktf/provider-cloudflare'

new accessOrganization.AccessOrganizationCustomPagesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

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

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): AccessOrganizationCustomPagesOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| AccessOrganizationCustomPages[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | AccessOrganizationCustomPages[];

Type: cdktf.IResolvable | AccessOrganizationCustomPages[]

AccessOrganizationCustomPagesOutputReference

Initializers

import { accessOrganization } from '@cdktf/provider-cloudflare'

new accessOrganization.AccessOrganizationCustomPagesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

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

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetForbidden`	No description.
`resetIdentityDenied`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetForbidden`

public resetForbidden(): void

`resetIdentityDenied`

public resetIdentityDenied(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`forbiddenInput`	`string`	No description.
`identityDeniedInput`	`string`	No description.
`forbidden`	`string`	No description.
`identityDenied`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| AccessOrganizationCustomPages`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`forbiddenInput`^Optional

public readonly forbiddenInput: string;

Type: string

`identityDeniedInput`^Optional

public readonly identityDeniedInput: string;

Type: string

`forbidden`^Required

public readonly forbidden: string;

Type: string

`identityDenied`^Required

public readonly identityDenied: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | AccessOrganizationCustomPages;

Type: cdktf.IResolvable | AccessOrganizationCustomPages

AccessOrganizationLoginDesignList

Initializers

import { accessOrganization } from '@cdktf/provider-cloudflare'

new accessOrganization.AccessOrganizationLoginDesignList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

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

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): AccessOrganizationLoginDesignOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| AccessOrganizationLoginDesign[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | AccessOrganizationLoginDesign[];

Type: cdktf.IResolvable | AccessOrganizationLoginDesign[]

AccessOrganizationLoginDesignOutputReference

Initializers

import { accessOrganization } from '@cdktf/provider-cloudflare'

new accessOrganization.AccessOrganizationLoginDesignOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

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

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetBackgroundColor`	No description.
`resetFooterText`	No description.
`resetHeaderText`	No description.
`resetLogoPath`	No description.
`resetTextColor`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetBackgroundColor`

public resetBackgroundColor(): void

`resetFooterText`

public resetFooterText(): void

`resetHeaderText`

public resetHeaderText(): void

`resetLogoPath`

public resetLogoPath(): void

`resetTextColor`

public resetTextColor(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`backgroundColorInput`	`string`	No description.
`footerTextInput`	`string`	No description.
`headerTextInput`	`string`	No description.
`logoPathInput`	`string`	No description.
`textColorInput`	`string`	No description.
`backgroundColor`	`string`	No description.
`footerText`	`string`	No description.
`headerText`	`string`	No description.
`logoPath`	`string`	No description.
`textColor`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| AccessOrganizationLoginDesign`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`backgroundColorInput`^Optional

public readonly backgroundColorInput: string;

Type: string

`footerTextInput`^Optional

public readonly footerTextInput: string;

Type: string

`headerTextInput`^Optional

public readonly headerTextInput: string;

Type: string

`logoPathInput`^Optional

public readonly logoPathInput: string;

Type: string

`textColorInput`^Optional

public readonly textColorInput: string;

Type: string

`backgroundColor`^Required

public readonly backgroundColor: string;

Type: string

`footerText`^Required

public readonly footerText: string;

Type: string

`headerText`^Required

public readonly headerText: string;

Type: string

`logoPath`^Required

public readonly logoPath: string;

Type: string

`textColor`^Required

public readonly textColor: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | AccessOrganizationLoginDesign;

Type: cdktf.IResolvable | AccessOrganizationLoginDesign

Files

accessOrganization.typescript.md

Latest commit

History

accessOrganization.typescript.md

File metadata and controls

accessOrganization Submodule

Constructs