Class Workspace
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Workspace.Builder,
Workspace>
Describes a WorkSpace.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Workspace.Builder
builder()
final String
bundleId()
The identifier of the bundle used to create the WorkSpace.final String
The name of the WorkSpace, as seen by the operating system.final DataReplicationSettings
Indicates the settings of the data replication.final String
The identifier of the Directory Service directory for the WorkSpace.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The error code that is returned if the WorkSpace cannot be created.final String
The text of the error message that is returned if the WorkSpace cannot be created.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ModificationStates property.final boolean
For responses, this returns true if the service returned a value for the RelatedWorkspaces property.final boolean
For responses, this returns true if the service returned a value for the StandbyWorkspacesProperties property.final String
The IP address of the WorkSpace.final List
<ModificationState> The modification states of the WorkSpace.final List
<RelatedWorkspaceProperties> The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.final Boolean
Indicates whether the data stored on the root volume is encrypted.static Class
<? extends Workspace.Builder> final List
<StandbyWorkspacesProperties> The properties of the standby WorkSpacefinal WorkspaceState
state()
The operational state of the WorkSpace.final String
The operational state of the WorkSpace.final String
subnetId()
The identifier of the subnet for the WorkSpace.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userName()
The user for the WorkSpace.final Boolean
Indicates whether the data stored on the user volume is encrypted.final String
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.final String
The identifier of the WorkSpace.final String
The name of the user-decoupled WorkSpace.final WorkspaceProperties
The properties of the WorkSpace.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workspaceId
The identifier of the WorkSpace.
- Returns:
- The identifier of the WorkSpace.
-
directoryId
The identifier of the Directory Service directory for the WorkSpace.
- Returns:
- The identifier of the Directory Service directory for the WorkSpace.
-
userName
The user for the WorkSpace.
- Returns:
- The user for the WorkSpace.
-
ipAddress
The IP address of the WorkSpace.
- Returns:
- The IP address of the WorkSpace.
-
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 toUNHEALTHY
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.If the service returns an enum value that is not available in the current SDK version,
state
will returnWorkspaceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- 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 toUNHEALTHY
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. -
- See Also:
-
-
stateAsString
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 toUNHEALTHY
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.If the service returns an enum value that is not available in the current SDK version,
state
will returnWorkspaceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- 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 toUNHEALTHY
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. -
- See Also:
-
-
bundleId
The identifier of the bundle used to create the WorkSpace.
- Returns:
- The identifier of the bundle used to create the WorkSpace.
-
subnetId
The identifier of the subnet for the WorkSpace.
- Returns:
- The identifier of the subnet for the WorkSpace.
-
errorMessage
The text of the error message that is returned if the WorkSpace cannot be created.
- Returns:
- The text of the error message that is returned if the WorkSpace cannot be created.
-
errorCode
The error code that is returned if the WorkSpace cannot be created.
- Returns:
- The error code that is returned if the WorkSpace cannot be created.
-
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:
- The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
-
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:
- The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
-
userVolumeEncryptionEnabled
Indicates whether the data stored on the user volume is encrypted.
- Returns:
- Indicates whether the data stored on the user volume is encrypted.
-
rootVolumeEncryptionEnabled
Indicates whether the data stored on the root volume is encrypted.
- Returns:
- Indicates whether the data stored on the root volume is encrypted.
-
workspaceName
The name of the user-decoupled WorkSpace.
- Returns:
- The name of the user-decoupled WorkSpace.
-
workspaceProperties
The properties of the WorkSpace.
- Returns:
- The properties of the WorkSpace.
-
hasModificationStates
public final boolean hasModificationStates()For responses, this returns true if the service returned a value for the ModificationStates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
modificationStates
The modification states of the WorkSpace.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasModificationStates()
method.- Returns:
- The modification states of the WorkSpace.
-
hasRelatedWorkspaces
public final boolean hasRelatedWorkspaces()For responses, this returns true if the service returned a value for the RelatedWorkspaces property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
dataReplicationSettings
Indicates the settings of the data replication.
- Returns:
- Indicates the settings of the data replication.
-
hasStandbyWorkspacesProperties
public final boolean hasStandbyWorkspacesProperties()For responses, this returns true if the service returned a value for the StandbyWorkspacesProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
standbyWorkspacesProperties
The properties of the standby WorkSpace
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStandbyWorkspacesProperties()
method.- Returns:
- The properties of the standby WorkSpace
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Workspace.Builder,
Workspace> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-