googleWorkstationsWorkstationCluster.typescript.md

googleWorkstationsWorkstationCluster Submodule

Constructs

GoogleWorkstationsWorkstationCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster google_workstations_workstation_cluster}.

Initializers

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

new googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationCluster(scope: Construct, id: string, config: GoogleWorkstationsWorkstationClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	GoogleWorkstationsWorkstationClusterConfig	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: GoogleWorkstationsWorkstationClusterConfig

---

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".
putDomainConfig	No description.
putPrivateClusterConfig	No description.
putTimeouts	No description.
resetAnnotations	No description.
resetDisplayName	No description.
resetDomainConfig	No description.
resetId	No description.
resetLabels	No description.
resetLocation	No description.
resetPrivateClusterConfig	No description.
resetProject	No description.
resetTimeouts	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".

---

putDomainConfig

public putDomainConfig(value: GoogleWorkstationsWorkstationClusterDomainConfig): void

value^Required

• Type: GoogleWorkstationsWorkstationClusterDomainConfig

---

putPrivateClusterConfig

public putPrivateClusterConfig(value: GoogleWorkstationsWorkstationClusterPrivateClusterConfig): void

value^Required

• Type: GoogleWorkstationsWorkstationClusterPrivateClusterConfig

---

putTimeouts

public putTimeouts(value: GoogleWorkstationsWorkstationClusterTimeouts): void

value^Required

• Type: GoogleWorkstationsWorkstationClusterTimeouts

---

resetAnnotations

public resetAnnotations(): void

resetDisplayName

public resetDisplayName(): void

resetDomainConfig

public resetDomainConfig(): void

resetId

public resetId(): void

resetLabels

public resetLabels(): void

resetLocation

public resetLocation(): void

resetPrivateClusterConfig

public resetPrivateClusterConfig(): void

resetProject

public resetProject(): void

resetTimeouts

public resetTimeouts(): 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 GoogleWorkstationsWorkstationCluster resource upon running "cdktf plan ".

---

isConstruct

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationCluster.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 { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationCluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationCluster.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing GoogleWorkstationsWorkstationCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#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 GoogleWorkstationsWorkstationCluster 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.
conditions	GoogleWorkstationsWorkstationClusterConditionsList	No description.
controlPlaneIp	string	No description.
createTime	string	No description.
degraded	cdktf.IResolvable	No description.
domainConfig	GoogleWorkstationsWorkstationClusterDomainConfigOutputReference	No description.
effectiveAnnotations	cdktf.StringMap	No description.
effectiveLabels	cdktf.StringMap	No description.
etag	string	No description.
name	string	No description.
privateClusterConfig	GoogleWorkstationsWorkstationClusterPrivateClusterConfigOutputReference	No description.
terraformLabels	cdktf.StringMap	No description.
timeouts	GoogleWorkstationsWorkstationClusterTimeoutsOutputReference	No description.
uid	string	No description.
annotationsInput	{[ key: string ]: string}	No description.
displayNameInput	string	No description.
domainConfigInput	GoogleWorkstationsWorkstationClusterDomainConfig	No description.
idInput	string	No description.
labelsInput	{[ key: string ]: string}	No description.
locationInput	string	No description.
networkInput	string	No description.
privateClusterConfigInput	GoogleWorkstationsWorkstationClusterPrivateClusterConfig	No description.
projectInput	string	No description.
subnetworkInput	string	No description.
timeoutsInput	cdktf.IResolvable | GoogleWorkstationsWorkstationClusterTimeouts	No description.
workstationClusterIdInput	string	No description.
annotations	{[ key: string ]: string}	No description.
displayName	string	No description.
id	string	No description.
labels	{[ key: string ]: string}	No description.
location	string	No description.
network	string	No description.
project	string	No description.
subnetwork	string	No description.
workstationClusterId	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[]

---

conditions^Required

public readonly conditions: GoogleWorkstationsWorkstationClusterConditionsList;

• Type: GoogleWorkstationsWorkstationClusterConditionsList

---

controlPlaneIp^Required

public readonly controlPlaneIp: string;

• Type: string

---

createTime^Required

public readonly createTime: string;

• Type: string

---

degraded^Required

public readonly degraded: IResolvable;

• Type: cdktf.IResolvable

---

domainConfig^Required

public readonly domainConfig: GoogleWorkstationsWorkstationClusterDomainConfigOutputReference;

• Type: GoogleWorkstationsWorkstationClusterDomainConfigOutputReference

---

effectiveAnnotations^Required

public readonly effectiveAnnotations: StringMap;

• Type: cdktf.StringMap

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktf.StringMap

---

etag^Required

public readonly etag: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

privateClusterConfig^Required

public readonly privateClusterConfig: GoogleWorkstationsWorkstationClusterPrivateClusterConfigOutputReference;

• Type: GoogleWorkstationsWorkstationClusterPrivateClusterConfigOutputReference

---

terraformLabels^Required

public readonly terraformLabels: StringMap;

• Type: cdktf.StringMap

---

timeouts^Required

public readonly timeouts: GoogleWorkstationsWorkstationClusterTimeoutsOutputReference;

• Type: GoogleWorkstationsWorkstationClusterTimeoutsOutputReference

---

uid^Required

public readonly uid: string;

• Type: string

---

annotationsInput^Optional

public readonly annotationsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

displayNameInput^Optional

public readonly displayNameInput: string;

• Type: string

---

domainConfigInput^Optional

public readonly domainConfigInput: GoogleWorkstationsWorkstationClusterDomainConfig;

• Type: GoogleWorkstationsWorkstationClusterDomainConfig

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

labelsInput^Optional

public readonly labelsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

locationInput^Optional

public readonly locationInput: string;

• Type: string

---

networkInput^Optional

public readonly networkInput: string;

• Type: string

---

privateClusterConfigInput^Optional

public readonly privateClusterConfigInput: GoogleWorkstationsWorkstationClusterPrivateClusterConfig;

• Type: GoogleWorkstationsWorkstationClusterPrivateClusterConfig

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

subnetworkInput^Optional

public readonly subnetworkInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | GoogleWorkstationsWorkstationClusterTimeouts;

• Type: cdktf.IResolvable | GoogleWorkstationsWorkstationClusterTimeouts

---

workstationClusterIdInput^Optional

public readonly workstationClusterIdInput: string;

• Type: string

---

annotations^Required

public readonly annotations: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

displayName^Required

public readonly displayName: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

labels^Required

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

location^Required

public readonly location: string;

• Type: string

---

network^Required

public readonly network: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

subnetwork^Required

public readonly subnetwork: string;

• Type: string

---

workstationClusterId^Required

public readonly workstationClusterId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

GoogleWorkstationsWorkstationClusterConditions

Initializer

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

const googleWorkstationsWorkstationClusterConditions: googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterConditions = { ... }

GoogleWorkstationsWorkstationClusterConfig

Initializer

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

const googleWorkstationsWorkstationClusterConfig: googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterConfig = { ... }

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.
network	string	The relative resource name of the VPC network on which the instance can be accessed.
subnetwork	string	Name of the Compute Engine subnetwork in which instances associated with this cluster will be created.
workstationClusterId	string	ID to use for the workstation cluster.
annotations	{[ key: string ]: string}	Client-specified annotations. This is distinct from labels.
displayName	string	Human-readable name for this resource.
domainConfig	GoogleWorkstationsWorkstationClusterDomainConfig	domain_config block.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#id GoogleWorkstationsWorkstationCluster#id}.
labels	{[ key: string ]: string}	Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.
location	string	The location where the workstation cluster should reside.
privateClusterConfig	GoogleWorkstationsWorkstationClusterPrivateClusterConfig	private_cluster_config block.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#project GoogleWorkstationsWorkstationCluster#project}.
timeouts	GoogleWorkstationsWorkstationClusterTimeouts	timeouts block.

---

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[]

---

network^Required

public readonly network: string;

• Type: string

The relative resource name of the VPC network on which the instance can be accessed.

It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#network GoogleWorkstationsWorkstationCluster#network}

---

subnetwork^Required

public readonly subnetwork: string;

• Type: string

Name of the Compute Engine subnetwork in which instances associated with this cluster will be created.

Must be part of the subnetwork specified for this cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#subnetwork GoogleWorkstationsWorkstationCluster#subnetwork}

---

workstationClusterId^Required

public readonly workstationClusterId: string;

• Type: string

ID to use for the workstation cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#workstation_cluster_id GoogleWorkstationsWorkstationCluster#workstation_cluster_id}

---

annotations^Optional

public readonly annotations: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Client-specified annotations. This is distinct from labels.

Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#annotations GoogleWorkstationsWorkstationCluster#annotations}

---

displayName^Optional

public readonly displayName: string;

• Type: string

Human-readable name for this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#display_name GoogleWorkstationsWorkstationCluster#display_name}

---

domainConfig^Optional

public readonly domainConfig: GoogleWorkstationsWorkstationClusterDomainConfig;

• Type: GoogleWorkstationsWorkstationClusterDomainConfig

domain_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#domain_config GoogleWorkstationsWorkstationCluster#domain_config}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#id GoogleWorkstationsWorkstationCluster#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.

---

labels^Optional

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#labels GoogleWorkstationsWorkstationCluster#labels}

---

location^Optional

public readonly location: string;

• Type: string

The location where the workstation cluster should reside.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#location GoogleWorkstationsWorkstationCluster#location}

---

privateClusterConfig^Optional

public readonly privateClusterConfig: GoogleWorkstationsWorkstationClusterPrivateClusterConfig;

• Type: GoogleWorkstationsWorkstationClusterPrivateClusterConfig

private_cluster_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#private_cluster_config GoogleWorkstationsWorkstationCluster#private_cluster_config}

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#project GoogleWorkstationsWorkstationCluster#project}.

---

timeouts^Optional

public readonly timeouts: GoogleWorkstationsWorkstationClusterTimeouts;

• Type: GoogleWorkstationsWorkstationClusterTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#timeouts GoogleWorkstationsWorkstationCluster#timeouts}

---

GoogleWorkstationsWorkstationClusterDomainConfig

Initializer

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

const googleWorkstationsWorkstationClusterDomainConfig: googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterDomainConfig = { ... }

Properties

Name	Type	Description
domain	string	Domain used by Workstations for HTTP ingress.

---

domain^Required

public readonly domain: string;

• Type: string

Domain used by Workstations for HTTP ingress.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#domain GoogleWorkstationsWorkstationCluster#domain}

---

GoogleWorkstationsWorkstationClusterPrivateClusterConfig

Initializer

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

const googleWorkstationsWorkstationClusterPrivateClusterConfig: googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterPrivateClusterConfig = { ... }

Properties

Name	Type	Description
enablePrivateEndpoint	boolean | cdktf.IResolvable	Whether Workstations endpoint is private.
allowedProjects	string[]	Additional project IDs that are allowed to attach to the workstation cluster's service attachment.

---

enablePrivateEndpoint^Required

public readonly enablePrivateEndpoint: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether Workstations endpoint is private.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#enable_private_endpoint GoogleWorkstationsWorkstationCluster#enable_private_endpoint}

---

allowedProjects^Optional

public readonly allowedProjects: string[];

• Type: string[]

Additional project IDs that are allowed to attach to the workstation cluster's service attachment.

By default, the workstation cluster's project and the VPC host project (if different) are allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#allowed_projects GoogleWorkstationsWorkstationCluster#allowed_projects}

---

GoogleWorkstationsWorkstationClusterTimeouts

Initializer

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

const googleWorkstationsWorkstationClusterTimeouts: googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#create GoogleWorkstationsWorkstationCluster#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#delete GoogleWorkstationsWorkstationCluster#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#update GoogleWorkstationsWorkstationCluster#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#create GoogleWorkstationsWorkstationCluster#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#delete GoogleWorkstationsWorkstationCluster#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_workstations_workstation_cluster#update GoogleWorkstationsWorkstationCluster#update}.

---

Classes

GoogleWorkstationsWorkstationClusterConditionsList

Initializers

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

new googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterConditionsList(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): GoogleWorkstationsWorkstationClusterConditionsOutputReference

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.

---

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

---

GoogleWorkstationsWorkstationClusterConditionsOutputReference

Initializers

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

new googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterConditionsOutputReference(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.

---

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.

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.
code	number	No description.
details	cdktf.StringMapList	No description.
message	string	No description.
internalValue	GoogleWorkstationsWorkstationClusterConditions	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

---

code^Required

public readonly code: number;

• Type: number

---

details^Required

public readonly details: StringMapList;

• Type: cdktf.StringMapList

---

message^Required

public readonly message: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: GoogleWorkstationsWorkstationClusterConditions;

• Type: GoogleWorkstationsWorkstationClusterConditions

---

GoogleWorkstationsWorkstationClusterDomainConfigOutputReference

Initializers

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

new googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterDomainConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

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.

---

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.

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.
domainInput	string	No description.
domain	string	No description.
internalValue	GoogleWorkstationsWorkstationClusterDomainConfig	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

---

domainInput^Optional

public readonly domainInput: string;

• Type: string

---

domain^Required

public readonly domain: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: GoogleWorkstationsWorkstationClusterDomainConfig;

• Type: GoogleWorkstationsWorkstationClusterDomainConfig

---

GoogleWorkstationsWorkstationClusterPrivateClusterConfigOutputReference

Initializers

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

new googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterPrivateClusterConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

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.
resetAllowedProjects	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.

resetAllowedProjects

public resetAllowedProjects(): 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.
clusterHostname	string	No description.
serviceAttachmentUri	string	No description.
allowedProjectsInput	string[]	No description.
enablePrivateEndpointInput	boolean | cdktf.IResolvable	No description.
allowedProjects	string[]	No description.
enablePrivateEndpoint	boolean | cdktf.IResolvable	No description.
internalValue	GoogleWorkstationsWorkstationClusterPrivateClusterConfig	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

---

clusterHostname^Required

public readonly clusterHostname: string;

• Type: string

---

serviceAttachmentUri^Required

public readonly serviceAttachmentUri: string;

• Type: string

---

allowedProjectsInput^Optional

public readonly allowedProjectsInput: string[];

• Type: string[]

---

enablePrivateEndpointInput^Optional

public readonly enablePrivateEndpointInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

allowedProjects^Required

public readonly allowedProjects: string[];

• Type: string[]

---

enablePrivateEndpoint^Required

public readonly enablePrivateEndpoint: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

internalValue^Optional

public readonly internalValue: GoogleWorkstationsWorkstationClusterPrivateClusterConfig;

• Type: GoogleWorkstationsWorkstationClusterPrivateClusterConfig

---

GoogleWorkstationsWorkstationClusterTimeoutsOutputReference

Initializers

import { googleWorkstationsWorkstationCluster } from '@cdktf/provider-google-beta'

new googleWorkstationsWorkstationCluster.GoogleWorkstationsWorkstationClusterTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

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.
resetCreate	No description.
resetDelete	No description.
resetUpdate	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.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): 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.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | GoogleWorkstationsWorkstationClusterTimeouts	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

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | GoogleWorkstationsWorkstationClusterTimeouts;

• Type: cdktf.IResolvable | GoogleWorkstationsWorkstationClusterTimeouts

---