You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::WorkSpaces::Types::Workspace
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpaces::Types::Workspace
- Defined in:
- (unknown)
Overview
Describes a WorkSpace.
Instance Attribute Summary collapse
-
#bundle_id ⇒ String
The identifier of the bundle used to create the WorkSpace.
-
#computer_name ⇒ String
The name of the WorkSpace, as seen by the operating system.
-
#directory_id ⇒ String
The identifier of the AWS Directory Service directory for the WorkSpace.
-
#error_code ⇒ String
The error code that is returned if the WorkSpace cannot be created.
-
#error_message ⇒ String
The text of the error message that is returned if the WorkSpace cannot be created.
-
#ip_address ⇒ String
The IP address of the WorkSpace.
-
#modification_states ⇒ Array<Types::ModificationState>
The modification states of the WorkSpace.
-
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
-
#state ⇒ String
The operational state of the WorkSpace.
-
#subnet_id ⇒ String
The identifier of the subnet for the WorkSpace.
-
#user_name ⇒ String
The user for the WorkSpace.
-
#user_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the user volume is encrypted.
-
#volume_encryption_key ⇒ String
The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace.
-
#workspace_id ⇒ String
The identifier of the WorkSpace.
-
#workspace_properties ⇒ Types::WorkspaceProperties
The properties of the WorkSpace.
Instance Attribute Details
#bundle_id ⇒ String
The identifier of the bundle used to create the WorkSpace.
#computer_name ⇒ String
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
#directory_id ⇒ String
The identifier of the AWS Directory Service directory for the WorkSpace.
#error_code ⇒ String
The error code that is returned if the WorkSpace cannot be created.
#error_message ⇒ String
The text of the error message that is returned if the WorkSpace cannot be created.
#ip_address ⇒ String
The IP address of the WorkSpace.
#modification_states ⇒ Array<Types::ModificationState>
The modification states of the WorkSpace.
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
#state ⇒ String
The operational state of the WorkSpace.
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.
#subnet_id ⇒ String
The identifier of the subnet for the WorkSpace.
#user_name ⇒ String
The user for the WorkSpace.
#user_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the user volume is encrypted.
#volume_encryption_key ⇒ String
The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
#workspace_id ⇒ String
The identifier of the WorkSpace.
#workspace_properties ⇒ Types::WorkspaceProperties
The properties of the WorkSpace.