Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

zeroTrustDeviceSettings.typescript.md

Latest commit

 

History

History
1195 lines (740 loc) · 57.3 KB

zeroTrustDeviceSettings.typescript.md

File metadata and controls

1195 lines (740 loc) · 57.3 KB

zeroTrustDeviceSettings Submodule

Constructs

ZeroTrustDeviceSettings

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings cloudflare_zero_trust_device_settings}.

Initializers 

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

new zeroTrustDeviceSettings.ZeroTrustDeviceSettings(scope: Construct, id: string, config: ZeroTrustDeviceSettingsConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ZeroTrustDeviceSettingsConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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".
resetDisableForTime No description.
resetExternalEmergencySignalEnabled No description.
resetExternalEmergencySignalFingerprint No description.
resetExternalEmergencySignalInterval No description.
resetExternalEmergencySignalUrl No description.
resetGatewayProxyEnabled No description.
resetGatewayUdpProxyEnabled No description.
resetRootCertificateInstallationEnabled No description.
resetUseZtVirtualIp No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

resetDisableForTime 
public resetDisableForTime(): void
resetExternalEmergencySignalEnabled 
public resetExternalEmergencySignalEnabled(): void
resetExternalEmergencySignalFingerprint 
public resetExternalEmergencySignalFingerprint(): void
resetExternalEmergencySignalInterval 
public resetExternalEmergencySignalInterval(): void
resetExternalEmergencySignalUrl 
public resetExternalEmergencySignalUrl(): void
resetGatewayProxyEnabled 
public resetGatewayProxyEnabled(): void
resetGatewayUdpProxyEnabled 
public resetGatewayUdpProxyEnabled(): void
resetRootCertificateInstallationEnabled 
public resetRootCertificateInstallationEnabled(): void
resetUseZtVirtualIp 
public resetUseZtVirtualIp(): 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 ZeroTrustDeviceSettings resource upon running "cdktf plan ".
isConstruct 
import { zeroTrustDeviceSettings } from '@cdktf/provider-cloudflare'

zeroTrustDeviceSettings.ZeroTrustDeviceSettings.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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { zeroTrustDeviceSettings } from '@cdktf/provider-cloudflare'

zeroTrustDeviceSettings.ZeroTrustDeviceSettings.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { zeroTrustDeviceSettings } from '@cdktf/provider-cloudflare'

zeroTrustDeviceSettings.ZeroTrustDeviceSettings.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { zeroTrustDeviceSettings } from '@cdktf/provider-cloudflare'

zeroTrustDeviceSettings.ZeroTrustDeviceSettings.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing ZeroTrustDeviceSettings that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#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 ZeroTrustDeviceSettings 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.
accountIdInput string No description.
disableForTimeInput number No description.
externalEmergencySignalEnabledInput boolean | cdktf.IResolvable No description.
externalEmergencySignalFingerprintInput string No description.
externalEmergencySignalIntervalInput string No description.
externalEmergencySignalUrlInput string No description.
gatewayProxyEnabledInput boolean | cdktf.IResolvable No description.
gatewayUdpProxyEnabledInput boolean | cdktf.IResolvable No description.
rootCertificateInstallationEnabledInput boolean | cdktf.IResolvable No description.
useZtVirtualIpInput boolean | cdktf.IResolvable No description.
accountId string No description.
disableForTime number No description.
externalEmergencySignalEnabled boolean | cdktf.IResolvable No description.
externalEmergencySignalFingerprint string No description.
externalEmergencySignalInterval string No description.
externalEmergencySignalUrl string No description.
gatewayProxyEnabled boolean | cdktf.IResolvable No description.
gatewayUdpProxyEnabled boolean | cdktf.IResolvable No description.
rootCertificateInstallationEnabled boolean | cdktf.IResolvable No description.
useZtVirtualIp boolean | cdktf.IResolvable No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
accountIdInputOptional 
public readonly accountIdInput: string;
  • Type: string
disableForTimeInputOptional 
public readonly disableForTimeInput: number;
  • Type: number
externalEmergencySignalEnabledInputOptional 
public readonly externalEmergencySignalEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
externalEmergencySignalFingerprintInputOptional 
public readonly externalEmergencySignalFingerprintInput: string;
  • Type: string
externalEmergencySignalIntervalInputOptional 
public readonly externalEmergencySignalIntervalInput: string;
  • Type: string
externalEmergencySignalUrlInputOptional 
public readonly externalEmergencySignalUrlInput: string;
  • Type: string
gatewayProxyEnabledInputOptional 
public readonly gatewayProxyEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
gatewayUdpProxyEnabledInputOptional 
public readonly gatewayUdpProxyEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
rootCertificateInstallationEnabledInputOptional 
public readonly rootCertificateInstallationEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
useZtVirtualIpInputOptional 
public readonly useZtVirtualIpInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
accountIdRequired 
public readonly accountId: string;
  • Type: string
disableForTimeRequired 
public readonly disableForTime: number;
  • Type: number
externalEmergencySignalEnabledRequired 
public readonly externalEmergencySignalEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
externalEmergencySignalFingerprintRequired 
public readonly externalEmergencySignalFingerprint: string;
  • Type: string
externalEmergencySignalIntervalRequired 
public readonly externalEmergencySignalInterval: string;
  • Type: string
externalEmergencySignalUrlRequired 
public readonly externalEmergencySignalUrl: string;
  • Type: string
gatewayProxyEnabledRequired 
public readonly gatewayProxyEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
gatewayUdpProxyEnabledRequired 
public readonly gatewayUdpProxyEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
rootCertificateInstallationEnabledRequired 
public readonly rootCertificateInstallationEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
useZtVirtualIpRequired 
public readonly useZtVirtualIp: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

ZeroTrustDeviceSettingsConfig

Initializer 

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

const zeroTrustDeviceSettingsConfig: zeroTrustDeviceSettings.ZeroTrustDeviceSettingsConfig = { ... }

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.
accountId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#account_id ZeroTrustDeviceSettings#account_id}.
disableForTime number Sets the time limit, in seconds, that a user can use an override code to bypass WARP.
externalEmergencySignalEnabled boolean | cdktf.IResolvable Controls whether the external emergency disconnect feature is enabled.
externalEmergencySignalFingerprint string The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url.
externalEmergencySignalInterval string The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds.
externalEmergencySignalUrl string The HTTPS URL from which to fetch the emergency disconnect signal.
gatewayProxyEnabled boolean | cdktf.IResolvable Enable gateway proxy filtering on TCP.
gatewayUdpProxyEnabled boolean | cdktf.IResolvable Enable gateway proxy filtering on UDP.
rootCertificateInstallationEnabled boolean | cdktf.IResolvable Enable installation of cloudflare managed root certificate.
useZtVirtualIp boolean | cdktf.IResolvable Enable using CGNAT virtual IPv4.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
accountIdRequired 
public readonly accountId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#account_id ZeroTrustDeviceSettings#account_id}.

disableForTimeOptional 
public readonly disableForTime: number;
  • Type: number

Sets the time limit, in seconds, that a user can use an override code to bypass WARP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#disable_for_time ZeroTrustDeviceSettings#disable_for_time}

externalEmergencySignalEnabledOptional 
public readonly externalEmergencySignalEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Controls whether the external emergency disconnect feature is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#external_emergency_signal_enabled ZeroTrustDeviceSettings#external_emergency_signal_enabled}

externalEmergencySignalFingerprintOptional 
public readonly externalEmergencySignalFingerprint: string;
  • Type: string

The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url.

If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#external_emergency_signal_fingerprint ZeroTrustDeviceSettings#external_emergency_signal_fingerprint}

externalEmergencySignalIntervalOptional 
public readonly externalEmergencySignalInterval: string;
  • Type: string

The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#external_emergency_signal_interval ZeroTrustDeviceSettings#external_emergency_signal_interval}

externalEmergencySignalUrlOptional 
public readonly externalEmergencySignalUrl: string;
  • Type: string

The HTTPS URL from which to fetch the emergency disconnect signal.

Must use HTTPS and have an IPv4 or IPv6 address as the host.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#external_emergency_signal_url ZeroTrustDeviceSettings#external_emergency_signal_url}

gatewayProxyEnabledOptional 
public readonly gatewayProxyEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Enable gateway proxy filtering on TCP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#gateway_proxy_enabled ZeroTrustDeviceSettings#gateway_proxy_enabled}

gatewayUdpProxyEnabledOptional 
public readonly gatewayUdpProxyEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Enable gateway proxy filtering on UDP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#gateway_udp_proxy_enabled ZeroTrustDeviceSettings#gateway_udp_proxy_enabled}

rootCertificateInstallationEnabledOptional 
public readonly rootCertificateInstallationEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Enable installation of cloudflare managed root certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#root_certificate_installation_enabled ZeroTrustDeviceSettings#root_certificate_installation_enabled}

useZtVirtualIpOptional 
public readonly useZtVirtualIp: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Enable using CGNAT virtual IPv4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/zero_trust_device_settings#use_zt_virtual_ip ZeroTrustDeviceSettings#use_zt_virtual_ip}