AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::WorkSpaces::Workspace

CfnWorkspace

The `AWS::WorkSpaces::Workspace` resource specifies a WorkSpace. Updates are not supported for the `BundleId` , `RootVolumeEncryptionEnabled` , `UserVolumeEncryptionEnabled` , or `VolumeEncryptionKey` properties. To update these properties, you must also update a property that triggers a replacement, such as the `UserName` property.

Import

import { CfnWorkspace } from 'aws-cdk-lib/aws-workspaces';

Or use the module namespace:

import * as workspaces from 'aws-cdk-lib/aws-workspaces';
// workspaces.CfnWorkspace

Properties

Configuration passed to the constructor as CfnWorkspaceProps.

bundleIdRequired
string

The identifier of the bundle for the WorkSpace.

directoryIdRequired
string

The identifier of the Directory Service directory for the WorkSpace.

userNameRequired
string

The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

rootVolumeEncryptionEnabledOptional
boolean | IResolvable

Indicates whether the data stored on the root volume is encrypted.

tagsOptional
CfnTag[]

The tags for the WorkSpace.

userVolumeEncryptionEnabledOptional
boolean | IResolvable

Indicates whether the data stored on the user volume is encrypted.

volumeEncryptionKeyOptional
string

The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

workspacePropertiesOptional
IResolvable | WorkspacePropertiesProperty

The WorkSpace properties.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::WorkSpaces::WorkspaceView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-workspaces
CFN TypeAWS::WorkSpaces::Workspace
Properties8

Related Constructs

Explore This Service

External Links