class Aws::WorkSpaces::Types::Workspace

Describes a WorkSpace.

@!attribute [rw] workspace_id

The identifier of the WorkSpace.
@return [String]

@!attribute [rw] directory_id

The identifier of the AWS Directory Service directory for the
WorkSpace.
@return [String]

@!attribute [rw] user_name

The user for the WorkSpace.
@return [String]

@!attribute [rw] ip_address

The IP address of the WorkSpace.
@return [String]

@!attribute [rw] state

The operational state of the WorkSpace.

<note markdown="1"> 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][1]. If the WorkSpace ID isn't returned, then
the WorkSpace has been successfully terminated.

 </note>

[1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
@return [String]

@!attribute [rw] bundle_id

The identifier of the bundle used to create the WorkSpace.
@return [String]

@!attribute [rw] subnet_id

The identifier of the subnet for the WorkSpace.
@return [String]

@!attribute [rw] error_message

The text of the error message that is returned if the WorkSpace
cannot be created.
@return [String]

@!attribute [rw] error_code

The error code that is returned if the WorkSpace cannot be created.
@return [String]

@!attribute [rw] computer_name

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

[1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html
@return [String]

@!attribute [rw] volume_encryption_key

The symmetric AWS KMS customer master key (CMK) used to encrypt data
stored on your WorkSpace. Amazon WorkSpaces does not support
asymmetric CMKs.
@return [String]

@!attribute [rw] user_volume_encryption_enabled

Indicates whether the data stored on the user volume is encrypted.
@return [Boolean]

@!attribute [rw] root_volume_encryption_enabled

Indicates whether the data stored on the root volume is encrypted.
@return [Boolean]

@!attribute [rw] workspace_properties

The properties of the WorkSpace.
@return [Types::WorkspaceProperties]

@!attribute [rw] modification_states

The modification states of the WorkSpace.
@return [Array<Types::ModificationState>]

@see docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Workspace AWS API Documentation

Constants

SENSITIVE