# `AWS-CreateWorkSpace`
<a name="aws-create-workspace"></a>

 **Description** 

 The `AWS-CreateWorkSpace` runbook creates a new Amazon WorkSpaces virtual desktop, known as a WorkSpace, based on the values that you specify for the input parameters. For information about WorkSpaces, see [What is Amazon WorkSpaces?](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces.html) in the *Amazon WorkSpaces Administration Guide*.

 [Run this Automation (console)](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-CreateWorkspace) 

**Document type**

Automation

**Owner**

Amazon

**Platforms**

Linux, macOS, Windows

**Parameters**
+ AutomationAssumeRole

  Type: String

  Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses the permissions of the user that starts this runbook.
+ BundleId

  Type: String

  Description: (Required) The ID of the bundle to use for the WorkSpace.
+ ComputeTypeName

  Type: String

  Valid values: VALUE \$1 STANDARD \$1 PERFORMANCE \$1 POWER \$1 GRAPHICS \$1 POWERPRO \$1 GRAPHICSPRO

  Description: (Optional) The compute type for your WorkSpace.
+ DirectoryId

  Type: String

  Description: (Required) The ID of the directory to add your WorkSpace to.
+ RootVolumeEncryptionEnabled

  Type: Boolean

  Valid values: true \$1 false

  Default: false

  Description: (Optional) Determines whether the root volume of the WorkSpace is encrypted.
+ RootVolumeSizeGib

  Type: Integer

  Description: (Required) The size of the root volume for the WorkSpace.
+ RunningMode

  Type: String

  Valid values: ALWAYS\$1ON \$1 AUTO\$1STOP

  Description: (Required) The running mode of the WorkSpace.
+ RunningModeAutoStopTimeoutInMinutes

  Type: Integer

  Description: (Optional) The time after a user logs off when the WorkSpaces stops. Specify a value in 60-minute intervals.
+ Tags

  Type: String

  Description: (Optional) Tags that you want to apply to the WorkSpace.
+ UserName

  Type: String

  Description: (Required) The user name to associate with the WorkSpace.
+ UserVolumeEncryptionEnabled

  Type: Boolean

  Valid values: true \$1 false

  Default: false

  Description: (Optional) Determines whether the user volume of the WorkSpace is encrypted.
+ UserVolumeSizeGib

  Type: Integer

  Description: (Required) The size of the user volume for the WorkSpace.
+ VolumeEncryptionKey

  Type: String

  Description: (Optional) The symmetric AWS Key Management Service key that you want to use to encrypt data stored on your WorkSpace.

**Required IAM permissions**

The `AutomationAssumeRole` parameter requires the following actions to use the runbook successfully.
+  `workspaces:CreateWorkspaces` 
+  `workspaces:DescribeWorkspaces` 

 **Document Steps** 
+  `aws:executeScript` - Creates a WorkSpace based on the values that you specify for the input parameters.
+  `aws:waitForAwsResourceProperty` - Verifies the state of the WorkSpace is `AVAILABLE`.

 **Outputs** 

`CreateWorkspace.WorkspaceId`