software.amazon.awssdk.services.workspaces.model

Interface Workspace.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Workspace.Builder,Workspace>, SdkBuilder<Workspace.Builder,Workspace>, SdkPojo

Enclosing class:

Workspace

public static interface Workspace.Builder
extends SdkPojo, CopyableBuilder<Workspace.Builder,Workspace>

Method Summary

Modifier and Type	Method and Description
Workspace.Builder	bundleId(String bundleId) The identifier of the bundle used to create the WorkSpace.
Workspace.Builder	computerName(String computerName) The name of the WorkSpace, as seen by the operating system.
Workspace.Builder	directoryId(String directoryId) The identifier of the Directory Service directory for the WorkSpace.
Workspace.Builder	errorCode(String errorCode) The error code that is returned if the WorkSpace cannot be created.
Workspace.Builder	errorMessage(String errorMessage) The text of the error message that is returned if the WorkSpace cannot be created.
Workspace.Builder	ipAddress(String ipAddress) The IP address of the WorkSpace.
Workspace.Builder	modificationStates(Collection<ModificationState> modificationStates) The modification states of the WorkSpace.
Workspace.Builder	modificationStates(Consumer<ModificationState.Builder>... modificationStates) The modification states of the WorkSpace.
Workspace.Builder	modificationStates(ModificationState... modificationStates) The modification states of the WorkSpace.
Workspace.Builder	relatedWorkspaces(Collection<RelatedWorkspaceProperties> relatedWorkspaces) The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
Workspace.Builder	relatedWorkspaces(Consumer<RelatedWorkspaceProperties.Builder>... relatedWorkspaces) The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
Workspace.Builder	relatedWorkspaces(RelatedWorkspaceProperties... relatedWorkspaces) The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
Workspace.Builder	rootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled) Indicates whether the data stored on the root volume is encrypted.
Workspace.Builder	state(String state) The operational state of the WorkSpace.
Workspace.Builder	state(WorkspaceState state) The operational state of the WorkSpace.
Workspace.Builder	subnetId(String subnetId) The identifier of the subnet for the WorkSpace.
Workspace.Builder	userName(String userName) The user for the WorkSpace.
Workspace.Builder	userVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled) Indicates whether the data stored on the user volume is encrypted.
Workspace.Builder	volumeEncryptionKey(String volumeEncryptionKey) The symmetric KMS key used to encrypt data stored on your WorkSpace.
Workspace.Builder	workspaceId(String workspaceId) The identifier of the WorkSpace.
default Workspace.Builder	workspaceProperties(Consumer<WorkspaceProperties.Builder> workspaceProperties) The properties of the WorkSpace.
Workspace.Builder	workspaceProperties(WorkspaceProperties workspaceProperties) The properties of the WorkSpace.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

workspaceId

Workspace.Builder workspaceId(String workspaceId)

The identifier of the WorkSpace.

Parameters:

workspaceId - The identifier of the WorkSpace.

Returns:

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

directoryId

Workspace.Builder directoryId(String directoryId)

The identifier of the Directory Service directory for the WorkSpace.

Parameters:

directoryId - The identifier of the Directory Service directory for the WorkSpace.

Returns:

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

userName

Workspace.Builder userName(String userName)

The user for the WorkSpace.

Parameters:

userName - The user for the WorkSpace.

Returns:

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

ipAddress

Workspace.Builder ipAddress(String ipAddress)

The IP address of the WorkSpace.

Parameters:

ipAddress - The IP address of the WorkSpace.

Returns:

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

state

Workspace.Builder state(String state)

The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

Parameters:

state - The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

Returns:

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

See Also:

WorkspaceState, WorkspaceState

state

Workspace.Builder state(WorkspaceState state)

The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

Parameters:

state - The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

Returns:

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

See Also:

WorkspaceState, WorkspaceState

bundleId

Workspace.Builder bundleId(String bundleId)

The identifier of the bundle used to create the WorkSpace.

Parameters:

bundleId - The identifier of the bundle used to create the WorkSpace.

Returns:

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

subnetId

Workspace.Builder subnetId(String subnetId)

The identifier of the subnet for the WorkSpace.

Parameters:

subnetId - The identifier of the subnet for the WorkSpace.

Returns:

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

errorMessage

Workspace.Builder errorMessage(String errorMessage)

The text of the error message that is returned if the WorkSpace cannot be created.

Parameters:

errorMessage - The text of the error message that is returned if the WorkSpace cannot be created.

Returns:

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

errorCode

Workspace.Builder errorCode(String errorCode)

The error code that is returned if the WorkSpace cannot be created.

Parameters:

errorCode - The error code that is returned if the WorkSpace cannot be created.

Returns:

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

computerName

Workspace.Builder computerName(String computerName)

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

Parameters:

computerName - The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

Returns:

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

volumeEncryptionKey

Workspace.Builder volumeEncryptionKey(String volumeEncryptionKey)

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

Parameters:

volumeEncryptionKey - 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

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

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

Workspace.Builder workspaceProperties(WorkspaceProperties workspaceProperties)

The properties of the WorkSpace.

Parameters:

workspaceProperties - The properties of the WorkSpace.

Returns:

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

workspaceProperties

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

The properties of the WorkSpace.

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:

workspaceProperties(WorkspaceProperties)

modificationStates

Workspace.Builder modificationStates(Collection<ModificationState> modificationStates)

The modification states of the WorkSpace.

Parameters:

modificationStates - The modification states of the WorkSpace.

Returns:

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

modificationStates

Workspace.Builder modificationStates(ModificationState... modificationStates)

The modification states of the WorkSpace.

Parameters:

modificationStates - The modification states of the WorkSpace.

Returns:

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

modificationStates

Workspace.Builder modificationStates(Consumer<ModificationState.Builder>... modificationStates)

The modification states of the WorkSpace.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #modificationStates(List).

Parameters:

modificationStates - a consumer that will call methods on ModificationState.Builder

Returns:

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

See Also:

#modificationStates(java.util.Collection)

relatedWorkspaces

Workspace.Builder relatedWorkspaces(Collection<RelatedWorkspaceProperties> relatedWorkspaces)

The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

Parameters:

relatedWorkspaces - The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

Returns:

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

relatedWorkspaces

Workspace.Builder relatedWorkspaces(RelatedWorkspaceProperties... relatedWorkspaces)

The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

Parameters:

relatedWorkspaces - The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

Returns:

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

relatedWorkspaces

Workspace.Builder relatedWorkspaces(Consumer<RelatedWorkspaceProperties.Builder>... relatedWorkspaces)

The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #relatedWorkspaces(List).

Parameters:

relatedWorkspaces - a consumer that will call methods on RelatedWorkspaceProperties.Builder

Returns:

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

See Also:

#relatedWorkspaces(java.util.Collection)