com.amazonaws.services.workspaces.model

Class WorkspaceProperties

java.lang.Object

com.amazonaws.services.workspaces.model.WorkspaceProperties

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkspaceProperties
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a WorkSpace.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkspaceProperties()

Method Summary

Modifier and Type	Method and Description
WorkspaceProperties	clone()
boolean	equals(Object obj)
String	getComputeTypeName() The compute type.
String	getOperatingSystemName() The name of the operating system.
List<String>	getProtocols() The protocol.
Integer	getRootVolumeSizeGib() The size of the root volume.
String	getRunningMode() The running mode.
Integer	getRunningModeAutoStopTimeoutInMinutes() The time after a user logs off when WorkSpaces are automatically stopped.
Integer	getUserVolumeSizeGib() The size of the user storage.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setComputeTypeName(Compute computeTypeName) The compute type.
void	setComputeTypeName(String computeTypeName) The compute type.
void	setOperatingSystemName(OperatingSystemName operatingSystemName) The name of the operating system.
void	setOperatingSystemName(String operatingSystemName) The name of the operating system.
void	setProtocols(Collection<String> protocols) The protocol.
void	setRootVolumeSizeGib(Integer rootVolumeSizeGib) The size of the root volume.
void	setRunningMode(RunningMode runningMode) The running mode.
void	setRunningMode(String runningMode) The running mode.
void	setRunningModeAutoStopTimeoutInMinutes(Integer runningModeAutoStopTimeoutInMinutes) The time after a user logs off when WorkSpaces are automatically stopped.
void	setUserVolumeSizeGib(Integer userVolumeSizeGib) The size of the user storage.
String	toString() Returns a string representation of this object.
WorkspaceProperties	withComputeTypeName(Compute computeTypeName) The compute type.
WorkspaceProperties	withComputeTypeName(String computeTypeName) The compute type.
WorkspaceProperties	withOperatingSystemName(OperatingSystemName operatingSystemName) The name of the operating system.
WorkspaceProperties	withOperatingSystemName(String operatingSystemName) The name of the operating system.
WorkspaceProperties	withProtocols(Collection<String> protocols) The protocol.
WorkspaceProperties	withProtocols(Protocol... protocols) The protocol.
WorkspaceProperties	withProtocols(String... protocols) The protocol.
WorkspaceProperties	withRootVolumeSizeGib(Integer rootVolumeSizeGib) The size of the root volume.
WorkspaceProperties	withRunningMode(RunningMode runningMode) The running mode.
WorkspaceProperties	withRunningMode(String runningMode) The running mode.
WorkspaceProperties	withRunningModeAutoStopTimeoutInMinutes(Integer runningModeAutoStopTimeoutInMinutes) The time after a user logs off when WorkSpaces are automatically stopped.
WorkspaceProperties	withUserVolumeSizeGib(Integer userVolumeSizeGib) The size of the user storage.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkspaceProperties

public WorkspaceProperties()

Method Detail

setRunningMode

public void setRunningMode(String runningMode)

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Parameters:

runningMode - The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

See Also:

RunningMode

getRunningMode

public String getRunningMode()

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Returns:

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

See Also:

RunningMode

withRunningMode

public WorkspaceProperties withRunningMode(String runningMode)

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Parameters:

runningMode - The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Returns:

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

See Also:

RunningMode

setRunningMode

public void setRunningMode(RunningMode runningMode)

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Parameters:

runningMode - The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

See Also:

RunningMode

withRunningMode

public WorkspaceProperties withRunningMode(RunningMode runningMode)

The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Parameters:

runningMode - The running mode. For more information, see Manage the WorkSpace Running Mode.

The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

Returns:

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

See Also:

RunningMode

setRunningModeAutoStopTimeoutInMinutes

public void setRunningModeAutoStopTimeoutInMinutes(Integer runningModeAutoStopTimeoutInMinutes)

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

Parameters:

runningModeAutoStopTimeoutInMinutes - The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

getRunningModeAutoStopTimeoutInMinutes

public Integer getRunningModeAutoStopTimeoutInMinutes()

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

Returns:

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

withRunningModeAutoStopTimeoutInMinutes

public WorkspaceProperties withRunningModeAutoStopTimeoutInMinutes(Integer runningModeAutoStopTimeoutInMinutes)

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

Parameters:

runningModeAutoStopTimeoutInMinutes - The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

Returns:

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

setRootVolumeSizeGib

public void setRootVolumeSizeGib(Integer rootVolumeSizeGib)

The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Parameters:

rootVolumeSizeGib - The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

getRootVolumeSizeGib

public Integer getRootVolumeSizeGib()

The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Returns:

The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

withRootVolumeSizeGib

public WorkspaceProperties withRootVolumeSizeGib(Integer rootVolumeSizeGib)

The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Parameters:

rootVolumeSizeGib - The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Returns:

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

setUserVolumeSizeGib

public void setUserVolumeSizeGib(Integer userVolumeSizeGib)

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Parameters:

userVolumeSizeGib - The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

getUserVolumeSizeGib

public Integer getUserVolumeSizeGib()

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Returns:

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

withUserVolumeSizeGib

public WorkspaceProperties withUserVolumeSizeGib(Integer userVolumeSizeGib)

The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Parameters:

userVolumeSizeGib - The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Returns:

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

setComputeTypeName

public void setComputeTypeName(String computeTypeName)

The compute type. For more information, see Amazon WorkSpaces Bundles.

Parameters:

computeTypeName - The compute type. For more information, see Amazon WorkSpaces Bundles.

See Also:

Compute

getComputeTypeName

public String getComputeTypeName()

The compute type. For more information, see Amazon WorkSpaces Bundles.

Returns:

The compute type. For more information, see Amazon WorkSpaces Bundles.

See Also:

Compute

withComputeTypeName

public WorkspaceProperties withComputeTypeName(String computeTypeName)

The compute type. For more information, see Amazon WorkSpaces Bundles.

Parameters:

computeTypeName - The compute type. For more information, see Amazon WorkSpaces Bundles.

Returns:

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

See Also:

Compute

setComputeTypeName

public void setComputeTypeName(Compute computeTypeName)

The compute type. For more information, see Amazon WorkSpaces Bundles.

Parameters:

computeTypeName - The compute type. For more information, see Amazon WorkSpaces Bundles.

See Also:

Compute

withComputeTypeName

public WorkspaceProperties withComputeTypeName(Compute computeTypeName)

The compute type. For more information, see Amazon WorkSpaces Bundles.

Parameters:

computeTypeName - The compute type. For more information, see Amazon WorkSpaces Bundles.

Returns:

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

See Also:

Compute

getProtocols

public List<String> getProtocols()

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Returns:

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

See Also:

Protocol

setProtocols

public void setProtocols(Collection<String> protocols)

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Parameters:

protocols - The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

See Also:

Protocol

withProtocols

public WorkspaceProperties withProtocols(String... protocols)

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

NOTE: This method appends the values to the existing list (if any). Use setProtocols(java.util.Collection) or withProtocols(java.util.Collection) if you want to override the existing values.

Parameters:

protocols - The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Returns:

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

See Also:

Protocol

withProtocols

public WorkspaceProperties withProtocols(Collection<String> protocols)

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Parameters:

protocols - The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Returns:

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

See Also:

Protocol

withProtocols

public WorkspaceProperties withProtocols(Protocol... protocols)

The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Parameters:

protocols - The protocol. For more information, see Protocols for Amazon WorkSpaces.

• Only available for WorkSpaces created with PCoIP bundles.

• The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

• Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

Returns:

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

See Also:

Protocol

setOperatingSystemName

public void setOperatingSystemName(String operatingSystemName)

The name of the operating system.

Parameters:

operatingSystemName - The name of the operating system.

See Also:

OperatingSystemName

getOperatingSystemName

public String getOperatingSystemName()

The name of the operating system.

Returns:

The name of the operating system.

See Also:

OperatingSystemName

withOperatingSystemName

public WorkspaceProperties withOperatingSystemName(String operatingSystemName)

The name of the operating system.

Parameters:

operatingSystemName - The name of the operating system.

Returns:

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

See Also:

OperatingSystemName

setOperatingSystemName

public void setOperatingSystemName(OperatingSystemName operatingSystemName)

The name of the operating system.

Parameters:

operatingSystemName - The name of the operating system.

See Also:

OperatingSystemName

withOperatingSystemName

public WorkspaceProperties withOperatingSystemName(OperatingSystemName operatingSystemName)

The name of the operating system.

Parameters:

operatingSystemName - The name of the operating system.

Returns:

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

See Also:

OperatingSystemName

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public WorkspaceProperties clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.