Skip to content

Latest commit

 

History

History
2670 lines (1669 loc) · 131 KB

workspacesDirectory.md

File metadata and controls

2670 lines (1669 loc) · 131 KB

aws_workspaces_directory

Refer to the Terraform Registory for docs: aws_workspaces_directory.

workspacesDirectory Submodule

Constructs

WorkspacesDirectory

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

Initializers 

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

new workspacesDirectory.WorkspacesDirectory(scope: Construct, id: string, config: WorkspacesDirectoryConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config WorkspacesDirectoryConfig 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.
putSelfServicePermissions No description.
putWorkspaceAccessProperties No description.
putWorkspaceCreationProperties No description.
resetId No description.
resetIpGroupIds No description.
resetSelfServicePermissions No description.
resetSubnetIds No description.
resetTags No description.
resetTagsAll No description.
resetWorkspaceAccessProperties No description.
resetWorkspaceCreationProperties 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
putSelfServicePermissions 
public putSelfServicePermissions(value: WorkspacesDirectorySelfServicePermissions): void
valueRequired
putWorkspaceAccessProperties 
public putWorkspaceAccessProperties(value: WorkspacesDirectoryWorkspaceAccessProperties): void
valueRequired
putWorkspaceCreationProperties 
public putWorkspaceCreationProperties(value: WorkspacesDirectoryWorkspaceCreationProperties): void
valueRequired
resetId 
public resetId(): void
resetIpGroupIds 
public resetIpGroupIds(): void
resetSelfServicePermissions 
public resetSelfServicePermissions(): void
resetSubnetIds 
public resetSubnetIds(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetWorkspaceAccessProperties 
public resetWorkspaceAccessProperties(): void
resetWorkspaceCreationProperties 
public resetWorkspaceCreationProperties(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { workspacesDirectory } from '@cdktf/aws-cdk'

workspacesDirectory.WorkspacesDirectory.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 { workspacesDirectory } from '@cdktf/aws-cdk'

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

workspacesDirectory.WorkspacesDirectory.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.
alias string No description.
customerUserName string No description.
directoryName string No description.
directoryType string No description.
dnsIpAddresses string[] No description.
iamRoleId string No description.
registrationCode string No description.
selfServicePermissions WorkspacesDirectorySelfServicePermissionsOutputReference No description.
workspaceAccessProperties WorkspacesDirectoryWorkspaceAccessPropertiesOutputReference No description.
workspaceCreationProperties WorkspacesDirectoryWorkspaceCreationPropertiesOutputReference No description.
workspaceSecurityGroupId string No description.
directoryIdInput string No description.
idInput string No description.
ipGroupIdsInput string[] No description.
selfServicePermissionsInput WorkspacesDirectorySelfServicePermissions No description.
subnetIdsInput string[] No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
workspaceAccessPropertiesInput WorkspacesDirectoryWorkspaceAccessProperties No description.
workspaceCreationPropertiesInput WorkspacesDirectoryWorkspaceCreationProperties No description.
directoryId string No description.
id string No description.
ipGroupIds string[] No description.
subnetIds string[] No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: 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[]
aliasRequired 
public readonly alias: string;
  • Type: string
customerUserNameRequired 
public readonly customerUserName: string;
  • Type: string
directoryNameRequired 
public readonly directoryName: string;
  • Type: string
directoryTypeRequired 
public readonly directoryType: string;
  • Type: string
dnsIpAddressesRequired 
public readonly dnsIpAddresses: string[];
  • Type: string[]
iamRoleIdRequired 
public readonly iamRoleId: string;
  • Type: string
registrationCodeRequired 
public readonly registrationCode: string;
  • Type: string
selfServicePermissionsRequired 
public readonly selfServicePermissions: WorkspacesDirectorySelfServicePermissionsOutputReference;
workspaceAccessPropertiesRequired 
public readonly workspaceAccessProperties: WorkspacesDirectoryWorkspaceAccessPropertiesOutputReference;
workspaceCreationPropertiesRequired 
public readonly workspaceCreationProperties: WorkspacesDirectoryWorkspaceCreationPropertiesOutputReference;
workspaceSecurityGroupIdRequired 
public readonly workspaceSecurityGroupId: string;
  • Type: string
directoryIdInputOptional 
public readonly directoryIdInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
ipGroupIdsInputOptional 
public readonly ipGroupIdsInput: string[];
  • Type: string[]
selfServicePermissionsInputOptional 
public readonly selfServicePermissionsInput: WorkspacesDirectorySelfServicePermissions;
subnetIdsInputOptional 
public readonly subnetIdsInput: string[];
  • Type: string[]
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
workspaceAccessPropertiesInputOptional 
public readonly workspaceAccessPropertiesInput: WorkspacesDirectoryWorkspaceAccessProperties;
workspaceCreationPropertiesInputOptional 
public readonly workspaceCreationPropertiesInput: WorkspacesDirectoryWorkspaceCreationProperties;
directoryIdRequired 
public readonly directoryId: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
ipGroupIdsRequired 
public readonly ipGroupIds: string[];
  • Type: string[]
subnetIdsRequired 
public readonly subnetIds: string[];
  • Type: string[]
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

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

Structs

WorkspacesDirectoryConfig

Initializer 

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

const workspacesDirectoryConfig: workspacesDirectory.WorkspacesDirectoryConfig = { ... }

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/3.76.1/docs/resources/workspaces_directory#directory_id WorkspacesDirectory#directory_id}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#id WorkspacesDirectory#id}.
ipGroupIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#ip_group_ids WorkspacesDirectory#ip_group_ids}.
selfServicePermissions WorkspacesDirectorySelfServicePermissions self_service_permissions block.
subnetIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#subnet_ids WorkspacesDirectory#subnet_ids}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#tags WorkspacesDirectory#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#tags_all WorkspacesDirectory#tags_all}.
workspaceAccessProperties WorkspacesDirectoryWorkspaceAccessProperties workspace_access_properties block.
workspaceCreationProperties WorkspacesDirectoryWorkspaceCreationProperties workspace_creation_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[]
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_directory#directory_id WorkspacesDirectory#directory_id}.

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_directory#id WorkspacesDirectory#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.

ipGroupIdsOptional 
public readonly ipGroupIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#ip_group_ids WorkspacesDirectory#ip_group_ids}.

selfServicePermissionsOptional 
public readonly selfServicePermissions: WorkspacesDirectorySelfServicePermissions;

self_service_permissions block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#self_service_permissions WorkspacesDirectory#self_service_permissions}

subnetIdsOptional 
public readonly subnetIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#subnet_ids WorkspacesDirectory#subnet_ids}.

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_directory#tags WorkspacesDirectory#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_directory#tags_all WorkspacesDirectory#tags_all}.

workspaceAccessPropertiesOptional 
public readonly workspaceAccessProperties: WorkspacesDirectoryWorkspaceAccessProperties;

workspace_access_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#workspace_access_properties WorkspacesDirectory#workspace_access_properties}

workspaceCreationPropertiesOptional 
public readonly workspaceCreationProperties: WorkspacesDirectoryWorkspaceCreationProperties;

workspace_creation_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#workspace_creation_properties WorkspacesDirectory#workspace_creation_properties}

WorkspacesDirectorySelfServicePermissions

Initializer 

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

const workspacesDirectorySelfServicePermissions: workspacesDirectory.WorkspacesDirectorySelfServicePermissions = { ... }

Properties

Name Type Description
changeComputeType boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#change_compute_type WorkspacesDirectory#change_compute_type}.
increaseVolumeSize boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#increase_volume_size WorkspacesDirectory#increase_volume_size}.
rebuildWorkspace boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#rebuild_workspace WorkspacesDirectory#rebuild_workspace}.
restartWorkspace boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#restart_workspace WorkspacesDirectory#restart_workspace}.
switchRunningMode boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#switch_running_mode WorkspacesDirectory#switch_running_mode}.
changeComputeTypeOptional 
public readonly changeComputeType: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#change_compute_type WorkspacesDirectory#change_compute_type}.

increaseVolumeSizeOptional 
public readonly increaseVolumeSize: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#increase_volume_size WorkspacesDirectory#increase_volume_size}.

rebuildWorkspaceOptional 
public readonly rebuildWorkspace: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#rebuild_workspace WorkspacesDirectory#rebuild_workspace}.

restartWorkspaceOptional 
public readonly restartWorkspace: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#restart_workspace WorkspacesDirectory#restart_workspace}.

switchRunningModeOptional 
public readonly switchRunningMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#switch_running_mode WorkspacesDirectory#switch_running_mode}.

WorkspacesDirectoryWorkspaceAccessProperties

Initializer 

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

const workspacesDirectoryWorkspaceAccessProperties: workspacesDirectory.WorkspacesDirectoryWorkspaceAccessProperties = { ... }

Properties

Name Type Description
deviceTypeAndroid string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_android WorkspacesDirectory#device_type_android}.
deviceTypeChromeos string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_chromeos WorkspacesDirectory#device_type_chromeos}.
deviceTypeIos string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_ios WorkspacesDirectory#device_type_ios}.
deviceTypeLinux string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_linux WorkspacesDirectory#device_type_linux}.
deviceTypeOsx string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_osx WorkspacesDirectory#device_type_osx}.
deviceTypeWeb string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_web WorkspacesDirectory#device_type_web}.
deviceTypeWindows string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_windows WorkspacesDirectory#device_type_windows}.
deviceTypeZeroclient string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_zeroclient WorkspacesDirectory#device_type_zeroclient}.
deviceTypeAndroidOptional 
public readonly deviceTypeAndroid: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_android WorkspacesDirectory#device_type_android}.

deviceTypeChromeosOptional 
public readonly deviceTypeChromeos: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_chromeos WorkspacesDirectory#device_type_chromeos}.

deviceTypeIosOptional 
public readonly deviceTypeIos: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_ios WorkspacesDirectory#device_type_ios}.

deviceTypeLinuxOptional 
public readonly deviceTypeLinux: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_linux WorkspacesDirectory#device_type_linux}.

deviceTypeOsxOptional 
public readonly deviceTypeOsx: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_osx WorkspacesDirectory#device_type_osx}.

deviceTypeWebOptional 
public readonly deviceTypeWeb: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_web WorkspacesDirectory#device_type_web}.

deviceTypeWindowsOptional 
public readonly deviceTypeWindows: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_windows WorkspacesDirectory#device_type_windows}.

deviceTypeZeroclientOptional 
public readonly deviceTypeZeroclient: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#device_type_zeroclient WorkspacesDirectory#device_type_zeroclient}.

WorkspacesDirectoryWorkspaceCreationProperties

Initializer 

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

const workspacesDirectoryWorkspaceCreationProperties: workspacesDirectory.WorkspacesDirectoryWorkspaceCreationProperties = { ... }

Properties

Name Type Description
customSecurityGroupId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#custom_security_group_id WorkspacesDirectory#custom_security_group_id}.
defaultOu string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#default_ou WorkspacesDirectory#default_ou}.
enableInternetAccess boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#enable_internet_access WorkspacesDirectory#enable_internet_access}.
enableMaintenanceMode boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#enable_maintenance_mode WorkspacesDirectory#enable_maintenance_mode}.
userEnabledAsLocalAdministrator boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#user_enabled_as_local_administrator WorkspacesDirectory#user_enabled_as_local_administrator}.
customSecurityGroupIdOptional 
public readonly customSecurityGroupId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#custom_security_group_id WorkspacesDirectory#custom_security_group_id}.

defaultOuOptional 
public readonly defaultOu: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#default_ou WorkspacesDirectory#default_ou}.

enableInternetAccessOptional 
public readonly enableInternetAccess: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#enable_internet_access WorkspacesDirectory#enable_internet_access}.

enableMaintenanceModeOptional 
public readonly enableMaintenanceMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#enable_maintenance_mode WorkspacesDirectory#enable_maintenance_mode}.

userEnabledAsLocalAdministratorOptional 
public readonly userEnabledAsLocalAdministrator: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/workspaces_directory#user_enabled_as_local_administrator WorkspacesDirectory#user_enabled_as_local_administrator}.

Classes

WorkspacesDirectorySelfServicePermissionsOutputReference

Initializers 

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

new workspacesDirectory.WorkspacesDirectorySelfServicePermissionsOutputReference(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.
resetChangeComputeType No description.
resetIncreaseVolumeSize No description.
resetRebuildWorkspace No description.
resetRestartWorkspace No description.
resetSwitchRunningMode 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.

resetChangeComputeType 
public resetChangeComputeType(): void
resetIncreaseVolumeSize 
public resetIncreaseVolumeSize(): void
resetRebuildWorkspace 
public resetRebuildWorkspace(): void
resetRestartWorkspace 
public resetRestartWorkspace(): void
resetSwitchRunningMode 
public resetSwitchRunningMode(): 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.
changeComputeTypeInput boolean | cdktf.IResolvable No description.
increaseVolumeSizeInput boolean | cdktf.IResolvable No description.
rebuildWorkspaceInput boolean | cdktf.IResolvable No description.
restartWorkspaceInput boolean | cdktf.IResolvable No description.
switchRunningModeInput boolean | cdktf.IResolvable No description.
changeComputeType boolean | cdktf.IResolvable No description.
increaseVolumeSize boolean | cdktf.IResolvable No description.
rebuildWorkspace boolean | cdktf.IResolvable No description.
restartWorkspace boolean | cdktf.IResolvable No description.
switchRunningMode boolean | cdktf.IResolvable No description.
internalValue WorkspacesDirectorySelfServicePermissions 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
changeComputeTypeInputOptional 
public readonly changeComputeTypeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
increaseVolumeSizeInputOptional 
public readonly increaseVolumeSizeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
rebuildWorkspaceInputOptional 
public readonly rebuildWorkspaceInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
restartWorkspaceInputOptional 
public readonly restartWorkspaceInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
switchRunningModeInputOptional 
public readonly switchRunningModeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
changeComputeTypeRequired 
public readonly changeComputeType: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
increaseVolumeSizeRequired 
public readonly increaseVolumeSize: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
rebuildWorkspaceRequired 
public readonly rebuildWorkspace: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
restartWorkspaceRequired 
public readonly restartWorkspace: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
switchRunningModeRequired 
public readonly switchRunningMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: WorkspacesDirectorySelfServicePermissions;

WorkspacesDirectoryWorkspaceAccessPropertiesOutputReference

Initializers 

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

new workspacesDirectory.WorkspacesDirectoryWorkspaceAccessPropertiesOutputReference(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.
resetDeviceTypeAndroid No description.
resetDeviceTypeChromeos No description.
resetDeviceTypeIos No description.
resetDeviceTypeLinux No description.
resetDeviceTypeOsx No description.
resetDeviceTypeWeb No description.
resetDeviceTypeWindows No description.
resetDeviceTypeZeroclient 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.

resetDeviceTypeAndroid 
public resetDeviceTypeAndroid(): void
resetDeviceTypeChromeos 
public resetDeviceTypeChromeos(): void
resetDeviceTypeIos 
public resetDeviceTypeIos(): void
resetDeviceTypeLinux 
public resetDeviceTypeLinux(): void
resetDeviceTypeOsx 
public resetDeviceTypeOsx(): void
resetDeviceTypeWeb 
public resetDeviceTypeWeb(): void
resetDeviceTypeWindows 
public resetDeviceTypeWindows(): void
resetDeviceTypeZeroclient 
public resetDeviceTypeZeroclient(): 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.
deviceTypeAndroidInput string No description.
deviceTypeChromeosInput string No description.
deviceTypeIosInput string No description.
deviceTypeLinuxInput string No description.
deviceTypeOsxInput string No description.
deviceTypeWebInput string No description.
deviceTypeWindowsInput string No description.
deviceTypeZeroclientInput string No description.
deviceTypeAndroid string No description.
deviceTypeChromeos string No description.
deviceTypeIos string No description.
deviceTypeLinux string No description.
deviceTypeOsx string No description.
deviceTypeWeb string No description.
deviceTypeWindows string No description.
deviceTypeZeroclient string No description.
internalValue WorkspacesDirectoryWorkspaceAccessProperties 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
deviceTypeAndroidInputOptional 
public readonly deviceTypeAndroidInput: string;
  • Type: string
deviceTypeChromeosInputOptional 
public readonly deviceTypeChromeosInput: string;
  • Type: string
deviceTypeIosInputOptional 
public readonly deviceTypeIosInput: string;
  • Type: string
deviceTypeLinuxInputOptional 
public readonly deviceTypeLinuxInput: string;
  • Type: string
deviceTypeOsxInputOptional 
public readonly deviceTypeOsxInput: string;
  • Type: string
deviceTypeWebInputOptional 
public readonly deviceTypeWebInput: string;
  • Type: string
deviceTypeWindowsInputOptional 
public readonly deviceTypeWindowsInput: string;
  • Type: string
deviceTypeZeroclientInputOptional 
public readonly deviceTypeZeroclientInput: string;
  • Type: string
deviceTypeAndroidRequired 
public readonly deviceTypeAndroid: string;
  • Type: string
deviceTypeChromeosRequired 
public readonly deviceTypeChromeos: string;
  • Type: string
deviceTypeIosRequired 
public readonly deviceTypeIos: string;
  • Type: string
deviceTypeLinuxRequired 
public readonly deviceTypeLinux: string;
  • Type: string
deviceTypeOsxRequired 
public readonly deviceTypeOsx: string;
  • Type: string
deviceTypeWebRequired 
public readonly deviceTypeWeb: string;
  • Type: string
deviceTypeWindowsRequired 
public readonly deviceTypeWindows: string;
  • Type: string
deviceTypeZeroclientRequired 
public readonly deviceTypeZeroclient: string;
  • Type: string
internalValueOptional 
public readonly internalValue: WorkspacesDirectoryWorkspaceAccessProperties;

WorkspacesDirectoryWorkspaceCreationPropertiesOutputReference

Initializers 

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

new workspacesDirectory.WorkspacesDirectoryWorkspaceCreationPropertiesOutputReference(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.
resetCustomSecurityGroupId No description.
resetDefaultOu No description.
resetEnableInternetAccess No description.
resetEnableMaintenanceMode No description.
resetUserEnabledAsLocalAdministrator 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.

resetCustomSecurityGroupId 
public resetCustomSecurityGroupId(): void
resetDefaultOu 
public resetDefaultOu(): void
resetEnableInternetAccess 
public resetEnableInternetAccess(): void
resetEnableMaintenanceMode 
public resetEnableMaintenanceMode(): void
resetUserEnabledAsLocalAdministrator 
public resetUserEnabledAsLocalAdministrator(): 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.
customSecurityGroupIdInput string No description.
defaultOuInput string No description.
enableInternetAccessInput boolean | cdktf.IResolvable No description.
enableMaintenanceModeInput boolean | cdktf.IResolvable No description.
userEnabledAsLocalAdministratorInput boolean | cdktf.IResolvable No description.
customSecurityGroupId string No description.
defaultOu string No description.
enableInternetAccess boolean | cdktf.IResolvable No description.
enableMaintenanceMode boolean | cdktf.IResolvable No description.
userEnabledAsLocalAdministrator boolean | cdktf.IResolvable No description.
internalValue WorkspacesDirectoryWorkspaceCreationProperties 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
customSecurityGroupIdInputOptional 
public readonly customSecurityGroupIdInput: string;
  • Type: string
defaultOuInputOptional 
public readonly defaultOuInput: string;
  • Type: string
enableInternetAccessInputOptional 
public readonly enableInternetAccessInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableMaintenanceModeInputOptional 
public readonly enableMaintenanceModeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
userEnabledAsLocalAdministratorInputOptional 
public readonly userEnabledAsLocalAdministratorInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
customSecurityGroupIdRequired 
public readonly customSecurityGroupId: string;
  • Type: string
defaultOuRequired 
public readonly defaultOu: string;
  • Type: string
enableInternetAccessRequired 
public readonly enableInternetAccess: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableMaintenanceModeRequired 
public readonly enableMaintenanceMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
userEnabledAsLocalAdministratorRequired 
public readonly userEnabledAsLocalAdministrator: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: WorkspacesDirectoryWorkspaceCreationProperties;