AWS::WorkSpaces::Workspace WorkspaceProperties

Information about a WorkSpace.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ComputeTypeName" : String,
  "RootVolumeSizeGib" : Integer,
  "RunningMode" : String,
  "RunningModeAutoStopTimeoutInMinutes" : Integer,
  "UserVolumeSizeGib" : Integer
}

YAML

  ComputeTypeName: String
  RootVolumeSizeGib: Integer
  RunningMode: String
  RunningModeAutoStopTimeoutInMinutes: Integer
  UserVolumeSizeGib: Integer

Properties

ComputeTypeName

The compute type. For more information, see Amazon WorkSpaces Bundles.

Required: No

Type: String

Allowed values: VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

RunningMode

The running mode. For more information, see Manage the WorkSpace Running Mode.

Note

The MANUAL value 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.

Required: No

Type: String

Allowed values: AUTO_STOP | ALWAYS_ON | MANUAL

Update requires: No interruption

RunningModeAutoStopTimeoutInMinutes

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

See also

• WorkspaceProperties in the Amazon WorkSpaces API Reference