WorkspaceRequest
Describes the information used to create a WorkSpace.
Contents
- BundleId
-
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
Type: String
Pattern:
^wsb-[0-9a-z]{8,63}$
Required: Yes
- DirectoryId
-
The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 65.
Pattern:
^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)
Required: Yes
- UserName
-
The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace.
The username is not case-sensitive, but we recommend matching the case in the AWS Directory Service directory to avoid potential incompatibilities.
The reserved keyword,
[UNDEFINED]
, is used when creating user-decoupled WorkSpaces.Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: Yes
- RootVolumeEncryptionEnabled
-
Indicates whether the data stored on the root volume is encrypted.
Type: Boolean
Required: No
- Tags
-
The tags for the WorkSpace.
Type: Array of Tag objects
Required: No
- UserVolumeEncryptionEnabled
-
Indicates whether the data stored on the user volume is encrypted.
Type: Boolean
Required: No
- VolumeEncryptionKey
-
The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Type: String
Required: No
- WorkspaceName
-
The name of the user-decoupled WorkSpace.
Note
WorkspaceName
is required ifUserName
is[UNDEFINED]
for user-decoupled WorkSpaces.WorkspaceName
is not applicable ifUserName
is specified for user-assigned WorkSpaces.Type: String
Pattern:
^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$
Required: No
- WorkspaceProperties
-
The WorkSpace properties.
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: