WorkspaceCreationProperties - Amazon WorkSpaces Service

WorkspaceCreationProperties

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

Contents

CustomSecurityGroupId

The identifier of your custom security group.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 20.

Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

DefaultOu

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

Important
  • To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

  • The API doesn't validate whether the OU exists.

Type: String

Required: No

EnableInternetAccess

Indicates whether internet access is enabled for your WorkSpaces.

Type: Boolean

Required: No

EnableMaintenanceMode

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

Type: Boolean

Required: No

EnableWorkDocs

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

Note

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

Type: Boolean

Required: No

UserEnabledAsLocalAdministrator

Indicates whether users are local administrators of their WorkSpaces.

Type: Boolean

Required: No

See Also

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