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

Interface WorkspaceRequest.Builder

    • Method Detail

      • 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 username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

        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 username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

        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.

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

        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:
        #tags(java.util.Collection)

      • workspaceName

        WorkspaceRequest.Builder workspaceName​(String workspaceName)

        The name of the user-decoupled WorkSpace.

        WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.

        Parameters:
        workspaceName - The name of the user-decoupled WorkSpace.

        WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.

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