class Aws::WorkSpaces::Types::WorkspaceCreationProperties
Describes the default properties that are used for creating WorkSpaces
. For more information, see [Update Directory Details for Your WorkSpaces].
[1]: docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html
@note When making an API call, you may pass WorkspaceCreationProperties
data as a hash: { enable_work_docs: false, enable_internet_access: false, default_ou: "DefaultOu", custom_security_group_id: "SecurityGroupId", user_enabled_as_local_administrator: false, enable_maintenance_mode: false, }
@!attribute [rw] enable_work_docs
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces. <note markdown="1"> 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][1] in the *Amazon WorkDocs Administration Guide*. To delete a WorkDocs site, see [Deleting a Site][2] 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. </note> [1]: https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html [2]: https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html @return [Boolean]
@!attribute [rw] enable_internet_access
Indicates whether internet access is enabled for your WorkSpaces. @return [Boolean]
@!attribute [rw] default_ou
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][1] in the Microsoft documentation. * The API doesn't validate whether the OU exists. [1]: https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names @return [String]
@!attribute [rw] custom_security_group_id
The identifier of your custom security group. @return [String]
@!attribute [rw] user_enabled_as_local_administrator
Indicates whether users are local administrators of their WorkSpaces. @return [Boolean]
@!attribute [rw] enable_maintenance_mode
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see [WorkSpace Maintenance][1]. [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceCreationProperties AWS API Documentation
Constants
- SENSITIVE