You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkSpaces::Types::WorkspaceCreationProperties

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing WorkspaceCreationProperties as input to an Aws::Client method, you can use a vanilla 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,
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_security_group_id ⇒ String

The identifier of your custom security group.

Returns:

  • (String) —

    The identifier of your custom security group.

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

Returns:

  • (String) —

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

#enable_internet_access ⇒ Boolean

Indicates whether internet access is enabled for your WorkSpaces.

Returns:

  • (Boolean) —

    Indicates whether internet access is enabled for your WorkSpaces.

#enable_maintenance_mode ⇒ Boolean

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

Returns:

  • (Boolean) —

    Indicates whether maintenance mode is enabled for your WorkSpaces.

#enable_work_docs ⇒ 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.

Returns:

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

Returns:

  • (Boolean) —

    Indicates whether users are local administrators of their WorkSpaces.