Package 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 Details

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

      • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

      • AVAILABLE – The WorkSpace is running and has passed the health checks.

      • IMPAIRED – Refer to UNHEALTHY state.

      • UNHEALTHY – The WorkSpace is not responding to health checks.

      • REBOOTING – The WorkSpace is being rebooted (restarted).

      • STARTING – The WorkSpace is starting up and health checks are being run.

      • REBUILDING – The WorkSpace is being rebuilt.

      • RESTORING – The WorkSpace is being restored.

      • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

      • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

      • TERMINATING – The WorkSpace is being deleted.

      • TERMINATED – The WorkSpace has been deleted.

      • SUSPENDED – The WorkSpace has been suspended for image creation.

      • UPDATING – The WorkSpace is undergoing an update.

      • STOPPING – The WorkSpace is being stopped.

      • STOPPED – The WorkSpace has been stopped.

      • ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

      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.

      • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

      • AVAILABLE – The WorkSpace is running and has passed the health checks.

      • IMPAIRED – Refer to UNHEALTHY state.

      • UNHEALTHY – The WorkSpace is not responding to health checks.

      • REBOOTING – The WorkSpace is being rebooted (restarted).

      • STARTING – The WorkSpace is starting up and health checks are being run.

      • REBUILDING – The WorkSpace is being rebuilt.

      • RESTORING – The WorkSpace is being restored.

      • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

      • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

      • TERMINATING – The WorkSpace is being deleted.

      • TERMINATED – The WorkSpace has been deleted.

      • SUSPENDED – The WorkSpace has been suspended for image creation.

      • UPDATING – The WorkSpace is undergoing an update.

      • STOPPING – The WorkSpace is being stopped.

      • STOPPED – The WorkSpace has been stopped.

      • ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

      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:

    • state

      Workspace.Builder state(WorkspaceState state)

      The operational state of the WorkSpace.

      • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

      • AVAILABLE – The WorkSpace is running and has passed the health checks.

      • IMPAIRED – Refer to UNHEALTHY state.

      • UNHEALTHY – The WorkSpace is not responding to health checks.

      • REBOOTING – The WorkSpace is being rebooted (restarted).

      • STARTING – The WorkSpace is starting up and health checks are being run.

      • REBUILDING – The WorkSpace is being rebuilt.

      • RESTORING – The WorkSpace is being restored.

      • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

      • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

      • TERMINATING – The WorkSpace is being deleted.

      • TERMINATED – The WorkSpace has been deleted.

      • SUSPENDED – The WorkSpace has been suspended for image creation.

      • UPDATING – The WorkSpace is undergoing an update.

      • STOPPING – The WorkSpace is being stopped.

      • STOPPED – The WorkSpace has been stopped.

      • ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

      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.

      • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

      • AVAILABLE – The WorkSpace is running and has passed the health checks.

      • IMPAIRED – Refer to UNHEALTHY state.

      • UNHEALTHY – The WorkSpace is not responding to health checks.

      • REBOOTING – The WorkSpace is being rebooted (restarted).

      • STARTING – The WorkSpace is starting up and health checks are being run.

      • REBUILDING – The WorkSpace is being rebuilt.

      • RESTORING – The WorkSpace is being restored.

      • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

      • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

      • TERMINATING – The WorkSpace is being deleted.

      • TERMINATED – The WorkSpace has been deleted.

      • SUSPENDED – The WorkSpace has been suspended for image creation.

      • UPDATING – The WorkSpace is undergoing an update.

      • STOPPING – The WorkSpace is being stopped.

      • STOPPED – The WorkSpace has been stopped.

      • ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

      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:

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

      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.

    • workspaceName

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

    • 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:

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

      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:

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

      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:

    • dataReplicationSettings

      Workspace.Builder dataReplicationSettings(DataReplicationSettings dataReplicationSettings)

      Indicates the settings of the data replication.

      Parameters:
      dataReplicationSettings - Indicates the settings of the data replication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataReplicationSettings

      default Workspace.Builder dataReplicationSettings(Consumer<DataReplicationSettings.Builder> dataReplicationSettings)

      Indicates the settings of the data replication.

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

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

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

    • standbyWorkspacesProperties

      Workspace.Builder standbyWorkspacesProperties(Collection<StandbyWorkspacesProperties> standbyWorkspacesProperties)

      The properties of the standby WorkSpace

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

    • standbyWorkspacesProperties

      Workspace.Builder standbyWorkspacesProperties(StandbyWorkspacesProperties... standbyWorkspacesProperties)

      The properties of the standby WorkSpace

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

    • standbyWorkspacesProperties

      Workspace.Builder standbyWorkspacesProperties(Consumer<StandbyWorkspacesProperties.Builder>... standbyWorkspacesProperties)

      The properties of the standby WorkSpace

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

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

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