Skip to content

Latest commit

 

History

History
1984 lines (1238 loc) · 90.7 KB

workspacesWorkspace.md

File metadata and controls

1984 lines (1238 loc) · 90.7 KB

aws_workspaces_workspace

Refer to the Terraform Registory for docs: aws_workspaces_workspace.

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.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
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.
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
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putTimeouts 
public putTimeouts(value: WorkspacesWorkspaceTimeouts): void
valueRequired
putWorkspaceProperties 
public putWorkspaceProperties(value: WorkspacesWorkspaceWorkspaceProperties): void
valueRequired
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.
isConstruct 
import { workspacesWorkspace } from '@cdktf/aws-cdk'

workspacesWorkspace.WorkspacesWorkspace.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

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

workspacesWorkspace.WorkspacesWorkspace.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { workspacesWorkspace } from '@cdktf/aws-cdk'

workspacesWorkspace.WorkspacesWorkspace.isTerraformResource(x: any)
xRequired
  • Type: any

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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
computerNameRequired 
public readonly computerName: string;
  • Type: string
ipAddressRequired 
public readonly ipAddress: string;
  • Type: string
stateRequired 
public readonly state: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: WorkspacesWorkspaceTimeoutsOutputReference;
workspacePropertiesRequired 
public readonly workspaceProperties: WorkspacesWorkspaceWorkspacePropertiesOutputReference;
bundleIdInputOptional 
public readonly bundleIdInput: string;
  • Type: string
directoryIdInputOptional 
public readonly directoryIdInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
rootVolumeEncryptionEnabledInputOptional 
public readonly rootVolumeEncryptionEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | WorkspacesWorkspaceTimeouts;
userNameInputOptional 
public readonly userNameInput: string;
  • Type: string
userVolumeEncryptionEnabledInputOptional 
public readonly userVolumeEncryptionEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
volumeEncryptionKeyInputOptional 
public readonly volumeEncryptionKeyInput: string;
  • Type: string
workspacePropertiesInputOptional 
public readonly workspacePropertiesInput: WorkspacesWorkspaceWorkspaceProperties;
bundleIdRequired 
public readonly bundleId: string;
  • Type: string
directoryIdRequired 
public readonly directoryId: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
rootVolumeEncryptionEnabledRequired 
public readonly rootVolumeEncryptionEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
userNameRequired 
public readonly userName: string;
  • Type: string
userVolumeEncryptionEnabledRequired 
public readonly userVolumeEncryptionEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
volumeEncryptionKeyRequired 
public readonly volumeEncryptionKey: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
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.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
bundleIdRequired 
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}.

directoryIdRequired 
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}.

userNameRequired 
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}.

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

rootVolumeEncryptionEnabledOptional 
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}.

tagsOptional 
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}.

tagsAllOptional 
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}.

timeoutsOptional 
public readonly timeouts: 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}

userVolumeEncryptionEnabledOptional 
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}.

volumeEncryptionKeyOptional 
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}.

workspacePropertiesOptional 
public readonly workspaceProperties: 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}.
createOptional 
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}.

deleteOptional 
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}.

updateOptional 
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}.
computeTypeNameOptional 
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}.

rootVolumeSizeGibOptional 
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}.

runningModeOptional 
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}.

runningModeAutoStopTimeoutInMinutesOptional 
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}.

userVolumeSizeGibOptional 
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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: 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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
computeTypeNameInputOptional 
public readonly computeTypeNameInput: string;
  • Type: string
rootVolumeSizeGibInputOptional 
public readonly rootVolumeSizeGibInput: number;
  • Type: number
runningModeAutoStopTimeoutInMinutesInputOptional 
public readonly runningModeAutoStopTimeoutInMinutesInput: number;
  • Type: number
runningModeInputOptional 
public readonly runningModeInput: string;
  • Type: string
userVolumeSizeGibInputOptional 
public readonly userVolumeSizeGibInput: number;
  • Type: number
computeTypeNameRequired 
public readonly computeTypeName: string;
  • Type: string
rootVolumeSizeGibRequired 
public readonly rootVolumeSizeGib: number;
  • Type: number
runningModeRequired 
public readonly runningMode: string;
  • Type: string
runningModeAutoStopTimeoutInMinutesRequired 
public readonly runningModeAutoStopTimeoutInMinutes: number;
  • Type: number
userVolumeSizeGibRequired 
public readonly userVolumeSizeGib: number;
  • Type: number
internalValueOptional 
public readonly internalValue: WorkspacesWorkspaceWorkspaceProperties;