AWS::WorkSpaces::Workspace
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::WorkSpaces::Workspace", "Properties" : { "BundleId" :
String
, "DirectoryId" :String
, "RootVolumeEncryptionEnabled" :Boolean
, "Tags" :[ Tag, ... ]
, "UserName" :String
, "UserVolumeEncryptionEnabled" :Boolean
, "VolumeEncryptionKey" :String
, "WorkspaceProperties" :WorkspaceProperties
} }
YAML
Type: AWS::WorkSpaces::Workspace Properties: BundleId:
String
DirectoryId:String
RootVolumeEncryptionEnabled:Boolean
Tags:- Tag
UserName:String
UserVolumeEncryptionEnabled:Boolean
VolumeEncryptionKey:String
WorkspaceProperties:WorkspaceProperties
Properties
BundleId
-
The identifier of the bundle for the WorkSpace.
Required: Yes
Type: String
Pattern:
^wsb-[0-9a-z]{8,63}$
Update requires: Updates are not supported.
DirectoryId
-
The identifier of the AWS Directory Service directory for the WorkSpace.
Required: Yes
Type: String
Minimum:
10
Maximum:
65
Pattern:
^d-[0-9a-f]{8,63}$
Update requires: Some interruptions
RootVolumeEncryptionEnabled
-
Indicates whether the data stored on the root volume is encrypted.
Required: No
Type: Boolean
Update requires: Updates are not supported.
Tags
-
The tags for the WorkSpace.
Required: No
Type: List of Tag
Update requires: No interruption
UserName
-
The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace.
Required: Yes
Type: String
Minimum:
1
Maximum:
63
Update requires: Replacement
UserVolumeEncryptionEnabled
-
Indicates whether the data stored on the user volume is encrypted.
Required: No
Type: Boolean
Update requires: Updates are not supported.
VolumeEncryptionKey
-
The symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Required: No
Type: String
Update requires: Updates are not supported.
WorkspaceProperties
-
The WorkSpace properties.
Required: No
Type: WorkspaceProperties
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name.
For more information about using the Ref
function, see Ref.
See also
-
CreateWorkspaces in the Amazon WorkSpaces API Reference
-
Launch a Virtual Desktop Using Amazon WorkSpaces in the Amazon WorkSpaces Administration Guide