[ 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>]
[--cli-auto-prompt <value>]


--resource-id (string)

The identifier of the directory.

--workspace-creation-properties (structure)

The default properties for creating WorkSpaces.

EnableInternetAccess -> (boolean)

Indicates whether internet access is enabled for your WorkSpaces.

DefaultOu -> (string)

The default organizational unit (OU) for your WorkSpace directories.

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:

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.