Package software.amazon.awssdk.services.workspaces.model

Interface WorkspaceCreationProperties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkspaceCreationProperties.Builder,WorkspaceCreationProperties>, SdkBuilder<WorkspaceCreationProperties.Builder,WorkspaceCreationProperties>, SdkPojo
Enclosing class:
WorkspaceCreationProperties
public static interface WorkspaceCreationProperties.Builder extends SdkPojo, CopyableBuilder<WorkspaceCreationProperties.Builder,WorkspaceCreationProperties>

  • Method Details

    • enableWorkDocs

      WorkspaceCreationProperties.Builder enableWorkDocs(Boolean enableWorkDocs)

      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.

      Parameters:
      enableWorkDocs - 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:
      Returns a reference to this object so that method calls can be chained together.

    • enableInternetAccess

      WorkspaceCreationProperties.Builder enableInternetAccess(Boolean enableInternetAccess)

      Indicates whether internet access is enabled for your WorkSpaces.

      Parameters:
      enableInternetAccess - Indicates whether internet access is enabled for your WorkSpaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultOu

      WorkspaceCreationProperties.Builder defaultOu(String defaultOu)

      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.

      Parameters:
      defaultOu - 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:
      Returns a reference to this object so that method calls can be chained together.

    • customSecurityGroupId

      WorkspaceCreationProperties.Builder customSecurityGroupId(String customSecurityGroupId)

      The identifier of your custom security group.

      Parameters:
      customSecurityGroupId - The identifier of your custom security group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userEnabledAsLocalAdministrator

      WorkspaceCreationProperties.Builder userEnabledAsLocalAdministrator(Boolean userEnabledAsLocalAdministrator)

      Indicates whether users are local administrators of their WorkSpaces.

      Parameters:
      userEnabledAsLocalAdministrator - Indicates whether users are local administrators of their WorkSpaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableMaintenanceMode

      WorkspaceCreationProperties.Builder enableMaintenanceMode(Boolean enableMaintenanceMode)

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

      Parameters:
      enableMaintenanceMode - Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.