Menu
Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

WorkspaceRequest

Contains information about a WorkSpace creation request.

Contents

BundleId

The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: Yes

DirectoryId

The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.

Type: String

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes

RootVolumeEncryptionEnabled

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

Type: Boolean

Required: No

Tags

The tags of the WorkSpace request.

Type: Array of Tag objects

Required: No

UserName

The username that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: Yes

UserVolumeEncryptionEnabled

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

Type: Boolean

Required: No

VolumeEncryptionKey

The KMS key used to encrypt data stored on your WorkSpace.

Type: String

Required: No

WorkspaceProperties

Describes the properties of a WorkSpace.

Type: WorkspaceProperties object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: