WorkspaceProperties
Describes a WorkSpace.
Contents
- ComputeTypeName
-
The compute type. For more information, see Amazon WorkSpaces Bundles
. Type: String
Valid Values:
VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DNRequired: No
- OperatingSystemName
-
The name of the operating system.
Type: String
Valid Values:
AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022Required: No
- Protocols
-
The protocol. For more information, see Protocols for Amazon WorkSpaces
. Note
-
Only available for WorkSpaces created with PCoIP bundles.
-
The
Protocolsproperty is case sensitive. Ensure you usePCOIPorWSP. -
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
Type: Array of strings
Valid Values:
PCOIP | WSPRequired: No
-
- RootVolumeSizeGib
-
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Type: Integer
Required: No
- RunningMode
-
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The
MANUALvalue is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. Type: String
Valid Values:
AUTO_STOP | ALWAYS_ON | MANUALRequired: No
- RunningModeAutoStopTimeoutInMinutes
-
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
Type: Integer
Required: No
- UserVolumeSizeGib
-
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: