workspacesWorkspace.md

workspacesWorkspace Submodule

Constructs

WorkspacesWorkspace

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace aws_workspaces_workspace}.

Initializers

import { workspacesWorkspace } from '@cdktf/aws-cdk'

new workspacesWorkspace.WorkspacesWorkspace(scope: Construct, id: string, config: WorkspacesWorkspaceConfig)

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

---

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".
putTimeouts	No description.
putWorkspaceProperties	No description.
resetId	No description.
resetRootVolumeEncryptionEnabled	No description.
resetTags	No description.
resetTagsAll	No description.
resetTimeouts	No description.
resetUserVolumeEncryptionEnabled	No description.
resetVolumeEncryptionKey	No description.
resetWorkspaceProperties	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".

---

putTimeouts

public putTimeouts(value: WorkspacesWorkspaceTimeouts): void

value^Required

• Type: WorkspacesWorkspaceTimeouts

---

putWorkspaceProperties

public putWorkspaceProperties(value: WorkspacesWorkspaceWorkspaceProperties): void

value^Required

• Type: WorkspacesWorkspaceWorkspaceProperties

---

resetId

public resetId(): void

resetRootVolumeEncryptionEnabled

public resetRootVolumeEncryptionEnabled(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetTimeouts

public resetTimeouts(): void

resetUserVolumeEncryptionEnabled

public resetUserVolumeEncryptionEnabled(): void

resetVolumeEncryptionKey

public resetVolumeEncryptionKey(): void

resetWorkspaceProperties

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

---

isConstruct

import { workspacesWorkspace } from '@cdktf/aws-cdk'

workspacesWorkspace.WorkspacesWorkspace.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { workspacesWorkspace } from '@cdktf/aws-cdk'

workspacesWorkspace.WorkspacesWorkspace.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { workspacesWorkspace } from '@cdktf/aws-cdk'

workspacesWorkspace.WorkspacesWorkspace.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { workspacesWorkspace } from '@cdktf/aws-cdk'

workspacesWorkspace.WorkspacesWorkspace.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing WorkspacesWorkspace that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#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 WorkspacesWorkspace 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.
computerName	string	No description.
ipAddress	string	No description.
state	string	No description.
timeouts	WorkspacesWorkspaceTimeoutsOutputReference	No description.
workspaceProperties	WorkspacesWorkspaceWorkspacePropertiesOutputReference	No description.
bundleIdInput	string	No description.
directoryIdInput	string	No description.
idInput	string	No description.
rootVolumeEncryptionEnabledInput	boolean | cdktf.IResolvable	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
timeoutsInput	cdktf.IResolvable | WorkspacesWorkspaceTimeouts	No description.
userNameInput	string	No description.
userVolumeEncryptionEnabledInput	boolean | cdktf.IResolvable	No description.
volumeEncryptionKeyInput	string	No description.
workspacePropertiesInput	WorkspacesWorkspaceWorkspaceProperties	No description.
bundleId	string	No description.
directoryId	string	No description.
id	string	No description.
rootVolumeEncryptionEnabled	boolean | cdktf.IResolvable	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
userName	string	No description.
userVolumeEncryptionEnabled	boolean | cdktf.IResolvable	No description.
volumeEncryptionKey	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[]

---

computerName^Required

public readonly computerName: string;

• Type: string

---

ipAddress^Required

public readonly ipAddress: string;

• Type: string

---

state^Required

public readonly state: string;

• Type: string

---

timeouts^Required

public readonly timeouts: WorkspacesWorkspaceTimeoutsOutputReference;

• Type: WorkspacesWorkspaceTimeoutsOutputReference

---

workspaceProperties^Required

public readonly workspaceProperties: WorkspacesWorkspaceWorkspacePropertiesOutputReference;

• Type: WorkspacesWorkspaceWorkspacePropertiesOutputReference

---

bundleIdInput^Optional

public readonly bundleIdInput: string;

• Type: string

---

directoryIdInput^Optional

public readonly directoryIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

rootVolumeEncryptionEnabledInput^Optional

public readonly rootVolumeEncryptionEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

tagsAllInput^Optional

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

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

---

tagsInput^Optional

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

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

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | WorkspacesWorkspaceTimeouts;

• Type: cdktf.IResolvable | WorkspacesWorkspaceTimeouts

---

userNameInput^Optional

public readonly userNameInput: string;

• Type: string

---

userVolumeEncryptionEnabledInput^Optional

public readonly userVolumeEncryptionEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

volumeEncryptionKeyInput^Optional

public readonly volumeEncryptionKeyInput: string;

• Type: string

---

workspacePropertiesInput^Optional

public readonly workspacePropertiesInput: WorkspacesWorkspaceWorkspaceProperties;

• Type: WorkspacesWorkspaceWorkspaceProperties

---

bundleId^Required

public readonly bundleId: string;

• Type: string

---

directoryId^Required

public readonly directoryId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

rootVolumeEncryptionEnabled^Required

public readonly rootVolumeEncryptionEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

tags^Required

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

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

---

tagsAll^Required

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

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

---

userName^Required

public readonly userName: string;

• Type: string

---

userVolumeEncryptionEnabled^Required

public readonly userVolumeEncryptionEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

volumeEncryptionKey^Required

public readonly volumeEncryptionKey: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

WorkspacesWorkspaceConfig

Initializer

import { workspacesWorkspace } from '@cdktf/aws-cdk'

const workspacesWorkspaceConfig: workspacesWorkspace.WorkspacesWorkspaceConfig = { ... }

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.
bundleId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#bundle_id WorkspacesWorkspace#bundle_id}.
directoryId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#directory_id WorkspacesWorkspace#directory_id}.
userName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#user_name WorkspacesWorkspace#user_name}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#id WorkspacesWorkspace#id}.
rootVolumeEncryptionEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#root_volume_encryption_enabled WorkspacesWorkspace#root_volume_encryption_enabled}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#tags WorkspacesWorkspace#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#tags_all WorkspacesWorkspace#tags_all}.
timeouts	WorkspacesWorkspaceTimeouts	timeouts block.
userVolumeEncryptionEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#user_volume_encryption_enabled WorkspacesWorkspace#user_volume_encryption_enabled}.
volumeEncryptionKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#volume_encryption_key WorkspacesWorkspace#volume_encryption_key}.
workspaceProperties	WorkspacesWorkspaceWorkspaceProperties	workspace_properties 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[]

---

bundleId^Required

public readonly bundleId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#bundle_id WorkspacesWorkspace#bundle_id}.

---

directoryId^Required

public readonly directoryId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#directory_id WorkspacesWorkspace#directory_id}.

---

userName^Required

public readonly userName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#user_name WorkspacesWorkspace#user_name}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#id WorkspacesWorkspace#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.

---

rootVolumeEncryptionEnabled^Optional

public readonly rootVolumeEncryptionEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#root_volume_encryption_enabled WorkspacesWorkspace#root_volume_encryption_enabled}.

---

tags^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#tags WorkspacesWorkspace#tags}.

---

tagsAll^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#tags_all WorkspacesWorkspace#tags_all}.

---

timeouts^Optional

public readonly timeouts: WorkspacesWorkspaceTimeouts;

• Type: WorkspacesWorkspaceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#timeouts WorkspacesWorkspace#timeouts}

---

userVolumeEncryptionEnabled^Optional

public readonly userVolumeEncryptionEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#user_volume_encryption_enabled WorkspacesWorkspace#user_volume_encryption_enabled}.

---

volumeEncryptionKey^Optional

public readonly volumeEncryptionKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#volume_encryption_key WorkspacesWorkspace#volume_encryption_key}.

---

workspaceProperties^Optional

public readonly workspaceProperties: WorkspacesWorkspaceWorkspaceProperties;

• Type: WorkspacesWorkspaceWorkspaceProperties

workspace_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#workspace_properties WorkspacesWorkspace#workspace_properties}

---

WorkspacesWorkspaceTimeouts

Initializer

import { workspacesWorkspace } from '@cdktf/aws-cdk'

const workspacesWorkspaceTimeouts: workspacesWorkspace.WorkspacesWorkspaceTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#create WorkspacesWorkspace#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#delete WorkspacesWorkspace#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#update WorkspacesWorkspace#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#create WorkspacesWorkspace#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#delete WorkspacesWorkspace#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#update WorkspacesWorkspace#update}.

---

WorkspacesWorkspaceWorkspaceProperties

Initializer

import { workspacesWorkspace } from '@cdktf/aws-cdk'

const workspacesWorkspaceWorkspaceProperties: workspacesWorkspace.WorkspacesWorkspaceWorkspaceProperties = { ... }

Properties

Name	Type	Description
computeTypeName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#compute_type_name WorkspacesWorkspace#compute_type_name}.
rootVolumeSizeGib	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#root_volume_size_gib WorkspacesWorkspace#root_volume_size_gib}.
runningMode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#running_mode WorkspacesWorkspace#running_mode}.
runningModeAutoStopTimeoutInMinutes	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#running_mode_auto_stop_timeout_in_minutes WorkspacesWorkspace#running_mode_auto_stop_timeout_in_minutes}.
userVolumeSizeGib	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#user_volume_size_gib WorkspacesWorkspace#user_volume_size_gib}.

---

computeTypeName^Optional

public readonly computeTypeName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#compute_type_name WorkspacesWorkspace#compute_type_name}.

---

rootVolumeSizeGib^Optional

public readonly rootVolumeSizeGib: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#root_volume_size_gib WorkspacesWorkspace#root_volume_size_gib}.

---

runningMode^Optional

public readonly runningMode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#running_mode WorkspacesWorkspace#running_mode}.

---

runningModeAutoStopTimeoutInMinutes^Optional

public readonly runningModeAutoStopTimeoutInMinutes: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#running_mode_auto_stop_timeout_in_minutes WorkspacesWorkspace#running_mode_auto_stop_timeout_in_minutes}.

---

userVolumeSizeGib^Optional

public readonly userVolumeSizeGib: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_workspace#user_volume_size_gib WorkspacesWorkspace#user_volume_size_gib}.

---

Classes

WorkspacesWorkspaceTimeoutsOutputReference

Initializers

import { workspacesWorkspace } from '@cdktf/aws-cdk'

new workspacesWorkspace.WorkspacesWorkspaceTimeoutsOutputReference(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 | WorkspacesWorkspaceTimeouts	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 | WorkspacesWorkspaceTimeouts;

• Type: cdktf.IResolvable | WorkspacesWorkspaceTimeouts

---

WorkspacesWorkspaceWorkspacePropertiesOutputReference

Initializers

import { workspacesWorkspace } from '@cdktf/aws-cdk'

new workspacesWorkspace.WorkspacesWorkspaceWorkspacePropertiesOutputReference(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.
resetComputeTypeName	No description.
resetRootVolumeSizeGib	No description.
resetRunningMode	No description.
resetRunningModeAutoStopTimeoutInMinutes	No description.
resetUserVolumeSizeGib	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.

resetComputeTypeName

public resetComputeTypeName(): void

resetRootVolumeSizeGib

public resetRootVolumeSizeGib(): void

resetRunningMode

public resetRunningMode(): void

resetRunningModeAutoStopTimeoutInMinutes

public resetRunningModeAutoStopTimeoutInMinutes(): void

resetUserVolumeSizeGib

public resetUserVolumeSizeGib(): 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.
computeTypeNameInput	string	No description.
rootVolumeSizeGibInput	number	No description.
runningModeAutoStopTimeoutInMinutesInput	number	No description.
runningModeInput	string	No description.
userVolumeSizeGibInput	number	No description.
computeTypeName	string	No description.
rootVolumeSizeGib	number	No description.
runningMode	string	No description.
runningModeAutoStopTimeoutInMinutes	number	No description.
userVolumeSizeGib	number	No description.
internalValue	WorkspacesWorkspaceWorkspaceProperties	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

---

computeTypeNameInput^Optional

public readonly computeTypeNameInput: string;

• Type: string

---

rootVolumeSizeGibInput^Optional

public readonly rootVolumeSizeGibInput: number;

• Type: number

---

runningModeAutoStopTimeoutInMinutesInput^Optional

public readonly runningModeAutoStopTimeoutInMinutesInput: number;

• Type: number

---

runningModeInput^Optional

public readonly runningModeInput: string;

• Type: string

---

userVolumeSizeGibInput^Optional

public readonly userVolumeSizeGibInput: number;

• Type: number

---

computeTypeName^Required

public readonly computeTypeName: string;

• Type: string

---

rootVolumeSizeGib^Required

public readonly rootVolumeSizeGib: number;

• Type: number

---

runningMode^Required

public readonly runningMode: string;

• Type: string

---

runningModeAutoStopTimeoutInMinutes^Required

public readonly runningModeAutoStopTimeoutInMinutes: number;

• Type: number

---

userVolumeSizeGib^Required

public readonly userVolumeSizeGib: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: WorkspacesWorkspaceWorkspaceProperties;

• Type: WorkspacesWorkspaceWorkspaceProperties

---