Class: Aws::WorkSpaces::Types::WorkspaceCreationProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpaces::Types::WorkspaceCreationProperties
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-workspaces/types.rb
Overview
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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#custom_security_group_id ⇒ String
The identifier of your custom security group.
-
#default_ou ⇒ String
The default organizational unit (OU) for your WorkSpaces directories.
-
#enable_internet_access ⇒ Boolean
Indicates whether internet access is enabled for your WorkSpaces.
-
#enable_maintenance_mode ⇒ Boolean
Indicates whether maintenance mode is enabled for your WorkSpaces.
-
#enable_work_docs ⇒ Boolean
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
-
#user_enabled_as_local_administrator ⇒ Boolean
Indicates whether users are local administrators of their WorkSpaces.
Instance Attribute Details
#custom_security_group_id ⇒ String
The identifier of your custom security group.
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 |
# File 'lib/aws-sdk-workspaces/types.rb', line 4839 class WorkspaceCreationProperties < Struct.new( :enable_work_docs, :enable_internet_access, :default_ou, :custom_security_group_id, :user_enabled_as_local_administrator, :enable_maintenance_mode) SENSITIVE = [] include Aws::Structure end |
#default_ou ⇒ 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.
[1]: docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 |
# File 'lib/aws-sdk-workspaces/types.rb', line 4839 class WorkspaceCreationProperties < Struct.new( :enable_work_docs, :enable_internet_access, :default_ou, :custom_security_group_id, :user_enabled_as_local_administrator, :enable_maintenance_mode) SENSITIVE = [] include Aws::Structure end |
#enable_internet_access ⇒ Boolean
Indicates whether internet access is enabled for your WorkSpaces.
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 |
# File 'lib/aws-sdk-workspaces/types.rb', line 4839 class WorkspaceCreationProperties < Struct.new( :enable_work_docs, :enable_internet_access, :default_ou, :custom_security_group_id, :user_enabled_as_local_administrator, :enable_maintenance_mode) SENSITIVE = [] include Aws::Structure end |
#enable_maintenance_mode ⇒ Boolean
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see [WorkSpace Maintenance].
[1]: docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 |
# File 'lib/aws-sdk-workspaces/types.rb', line 4839 class WorkspaceCreationProperties < Struct.new( :enable_work_docs, :enable_internet_access, :default_ou, :custom_security_group_id, :user_enabled_as_local_administrator, :enable_maintenance_mode) SENSITIVE = [] include Aws::Structure end |
#enable_work_docs ⇒ Boolean
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] 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.
</note>
[1]: docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html [2]: docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 |
# File 'lib/aws-sdk-workspaces/types.rb', line 4839 class WorkspaceCreationProperties < Struct.new( :enable_work_docs, :enable_internet_access, :default_ou, :custom_security_group_id, :user_enabled_as_local_administrator, :enable_maintenance_mode) SENSITIVE = [] include Aws::Structure end |
#user_enabled_as_local_administrator ⇒ Boolean
Indicates whether users are local administrators of their WorkSpaces.
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 |
# File 'lib/aws-sdk-workspaces/types.rb', line 4839 class WorkspaceCreationProperties < Struct.new( :enable_work_docs, :enable_internet_access, :default_ou, :custom_security_group_id, :user_enabled_as_local_administrator, :enable_maintenance_mode) SENSITIVE = [] include Aws::Structure end |