[ aws . workspaces ]



Modify the default properties used to create WorkSpaces.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--resource-id <value>
--workspace-creation-properties <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--resource-id (string)

The identifier of the directory.

--workspace-creation-properties (structure)

The default properties for creating WorkSpaces.

EnableWorkDocs -> (boolean)

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.


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.

EnableInternetAccess -> (boolean)

Indicates whether internet access is enabled for your WorkSpaces.

DefaultOu -> (string)

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 .


  • 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.

CustomSecurityGroupId -> (string)

The identifier of your custom security group.

UserEnabledAsLocalAdministrator -> (boolean)

Indicates whether users are local administrators of their WorkSpaces.

EnableMaintenanceMode -> (boolean)

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

Shorthand Syntax:


JSON Syntax:

  "EnableWorkDocs": true|false,
  "EnableInternetAccess": true|false,
  "DefaultOu": "string",
  "CustomSecurityGroupId": "string",
  "UserEnabledAsLocalAdministrator": true|false,
  "EnableMaintenanceMode": true|false

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.