dataAwsWorkspacesWorkspace.typescript.md

dataAwsWorkspacesWorkspace Submodule

Constructs

DataAwsWorkspacesWorkspace

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace aws_workspaces_workspace}.

Initializers

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

new dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspace(scope: Construct, id: string, config?: DataAwsWorkspacesWorkspaceConfig)

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

• Type: DataAwsWorkspacesWorkspaceConfig

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
resetDirectoryId	No description.
resetId	No description.
resetTags	No description.
resetUserName	No description.
resetWorkspaceId	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

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

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(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetDirectoryId

public resetDirectoryId(): void

resetId

public resetId(): void

resetTags

public resetTags(): void

resetUserName

public resetUserName(): void

resetWorkspaceId

public resetWorkspaceId(): void

Static Functions

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

---

isConstruct

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspace.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 { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspace.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspace.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspace.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataAwsWorkspacesWorkspace that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/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 DataAwsWorkspacesWorkspace 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.
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.
bundleId	string	No description.
computerName	string	No description.
ipAddress	string	No description.
rootVolumeEncryptionEnabled	cdktf.IResolvable	No description.
state	string	No description.
userVolumeEncryptionEnabled	cdktf.IResolvable	No description.
volumeEncryptionKey	string	No description.
workspaceProperties	DataAwsWorkspacesWorkspaceWorkspacePropertiesList	No description.
directoryIdInput	string	No description.
idInput	string	No description.
tagsInput	{[ key: string ]: string}	No description.
userNameInput	string	No description.
workspaceIdInput	string	No description.
directoryId	string	No description.
id	string	No description.
tags	{[ key: string ]: string}	No description.
userName	string	No description.
workspaceId	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

---

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

---

bundleId^Required

public readonly bundleId: string;

• Type: string

---

computerName^Required

public readonly computerName: string;

• Type: string

---

ipAddress^Required

public readonly ipAddress: string;

• Type: string

---

rootVolumeEncryptionEnabled^Required

public readonly rootVolumeEncryptionEnabled: IResolvable;

• Type: cdktf.IResolvable

---

state^Required

public readonly state: string;

• Type: string

---

userVolumeEncryptionEnabled^Required

public readonly userVolumeEncryptionEnabled: IResolvable;

• Type: cdktf.IResolvable

---

volumeEncryptionKey^Required

public readonly volumeEncryptionKey: string;

• Type: string

---

workspaceProperties^Required

public readonly workspaceProperties: DataAwsWorkspacesWorkspaceWorkspacePropertiesList;

• Type: DataAwsWorkspacesWorkspaceWorkspacePropertiesList

---

directoryIdInput^Optional

public readonly directoryIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

tagsInput^Optional

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

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

---

userNameInput^Optional

public readonly userNameInput: string;

• Type: string

---

workspaceIdInput^Optional

public readonly workspaceIdInput: string;

• Type: string

---

directoryId^Required

public readonly directoryId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

tags^Required

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

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

---

userName^Required

public readonly userName: string;

• Type: string

---

workspaceId^Required

public readonly workspaceId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataAwsWorkspacesWorkspaceConfig

Initializer

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

const dataAwsWorkspacesWorkspaceConfig: dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspaceConfig = { ... }

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.
directoryId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#directory_id DataAwsWorkspacesWorkspace#directory_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#id DataAwsWorkspacesWorkspace#id}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#tags DataAwsWorkspacesWorkspace#tags}.
userName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#user_name DataAwsWorkspacesWorkspace#user_name}.
workspaceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#workspace_id DataAwsWorkspacesWorkspace#workspace_id}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

directoryId^Optional

public readonly directoryId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#directory_id DataAwsWorkspacesWorkspace#directory_id}.

---

id^Optional

public readonly id: string;

• Type: string

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

---

tags^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#tags DataAwsWorkspacesWorkspace#tags}.

---

userName^Optional

public readonly userName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#user_name DataAwsWorkspacesWorkspace#user_name}.

---

workspaceId^Optional

public readonly workspaceId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/workspaces_workspace#workspace_id DataAwsWorkspacesWorkspace#workspace_id}.

---

DataAwsWorkspacesWorkspaceWorkspaceProperties

Initializer

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

const dataAwsWorkspacesWorkspaceWorkspaceProperties: dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspaceWorkspaceProperties = { ... }

Classes

DataAwsWorkspacesWorkspaceWorkspacePropertiesList

Initializers

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

new dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspaceWorkspacePropertiesList(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): DataAwsWorkspacesWorkspaceWorkspacePropertiesOutputReference

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

---

DataAwsWorkspacesWorkspaceWorkspacePropertiesOutputReference

Initializers

import { dataAwsWorkspacesWorkspace } from '@cdktf/provider-aws'

new dataAwsWorkspacesWorkspace.DataAwsWorkspacesWorkspaceWorkspacePropertiesOutputReference(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.
computeTypeName	string	No description.
rootVolumeSizeGib	number	No description.
runningMode	string	No description.
runningModeAutoStopTimeoutInMinutes	number	No description.
userVolumeSizeGib	number	No description.
internalValue	DataAwsWorkspacesWorkspaceWorkspaceProperties	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

---

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: DataAwsWorkspacesWorkspaceWorkspaceProperties;

• Type: DataAwsWorkspacesWorkspaceWorkspaceProperties

---