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

Interface WorkspaceRequest.Builder

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

  • Method Details

    • directoryId

      WorkspaceRequest.Builder directoryId(String directoryId)

      The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

      Parameters:
      directoryId - The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userName

      WorkspaceRequest.Builder userName(String userName)

      The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

      The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

      Parameters:
      userName - The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

      The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bundleId

      WorkspaceRequest.Builder bundleId(String bundleId)

      The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

      Parameters:
      bundleId - The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeEncryptionKey

      WorkspaceRequest.Builder volumeEncryptionKey(String volumeEncryptionKey)

      The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

      Parameters:
      volumeEncryptionKey - The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userVolumeEncryptionEnabled

      WorkspaceRequest.Builder userVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled)

      Indicates whether the data stored on the user volume is encrypted.

      Parameters:
      userVolumeEncryptionEnabled - Indicates whether the data stored on the user volume is encrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rootVolumeEncryptionEnabled

      WorkspaceRequest.Builder rootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)

      Indicates whether the data stored on the root volume is encrypted.

      Parameters:
      rootVolumeEncryptionEnabled - Indicates whether the data stored on the root volume is encrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceProperties

      WorkspaceRequest.Builder workspaceProperties(WorkspaceProperties workspaceProperties)

      The WorkSpace properties.

      Parameters:
      workspaceProperties - The WorkSpace properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceProperties

      default WorkspaceRequest.Builder workspaceProperties(Consumer<WorkspaceProperties.Builder> workspaceProperties)

      The WorkSpace properties.

      This is a convenience method that creates an instance of the WorkspaceProperties.Builder avoiding the need to create one manually via WorkspaceProperties.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workspaceProperties(WorkspaceProperties).

      Parameters:
      workspaceProperties - a consumer that will call methods on WorkspaceProperties.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      WorkspaceRequest.Builder tags(Collection<Tag> tags)

      The tags for the WorkSpace.

      Parameters:
      tags - The tags for the WorkSpace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      WorkspaceRequest.Builder tags(Tag... tags)

      The tags for the WorkSpace.

      Parameters:
      tags - The tags for the WorkSpace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      WorkspaceRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags for the WorkSpace.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceName

      WorkspaceRequest.Builder workspaceName(String workspaceName)

      The name of the user-decoupled WorkSpace.

      Parameters:
      workspaceName - The name of the user-decoupled WorkSpace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.