Class: Aws::WorkSpaces::Types::Workspace
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpaces::Types::Workspace
- Defined in:
- gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb
Overview
Describes a WorkSpace.
Constant Summary collapse
- SENSITIVE =
[]
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.
-
#data_replication_settings ⇒ Types::DataReplicationSettings
Indicates the settings of the data replication.
-
#directory_id ⇒ String
The identifier of the 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.
-
#related_workspaces ⇒ Array<Types::RelatedWorkspaceProperties>
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
-
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
-
#standby_workspaces_properties ⇒ Array<Types::StandbyWorkspacesProperties>
The properties of the standby WorkSpace.
-
#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 ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
-
#workspace_id ⇒ String
The identifier of the WorkSpace.
-
#workspace_name ⇒ String
The name of the user-decoupled 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.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#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.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#data_replication_settings ⇒ Types::DataReplicationSettings
Indicates the settings of the data replication.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#directory_id ⇒ String
The identifier of the Directory Service directory for the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#error_code ⇒ String
The error code that is returned if the WorkSpace cannot be created.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#error_message ⇒ String
The text of the error message that is returned if the WorkSpace cannot be created.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#ip_address ⇒ String
The IP address of the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#modification_states ⇒ Array<Types::ModificationState>
The modification states of the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#related_workspaces ⇒ Array<Types::RelatedWorkspaceProperties>
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#standby_workspaces_properties ⇒ Array<Types::StandbyWorkspacesProperties>
The properties of the standby WorkSpace
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#state ⇒ String
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).
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.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#subnet_id ⇒ String
The identifier of the subnet for the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#user_name ⇒ String
The user for the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#user_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the user volume is encrypted.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#volume_encryption_key ⇒ String
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#workspace_id ⇒ String
The identifier of the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#workspace_name ⇒ String
The name of the user-decoupled WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |
#workspace_properties ⇒ Types::WorkspaceProperties
The properties of the WorkSpace.
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4571 class Workspace < Struct.new( :workspace_id, :directory_id, :user_name, :ip_address, :state, :bundle_id, :subnet_id, :error_message, :error_code, :computer_name, :volume_encryption_key, :user_volume_encryption_enabled, :root_volume_encryption_enabled, :workspace_name, :workspace_properties, :modification_states, :related_workspaces, :data_replication_settings, :standby_workspaces_properties) SENSITIVE = [] include Aws::Structure end |