Class: Aws::WorkSpaces::Types::Workspace

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a WorkSpace.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle used to create the WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_nameString

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:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_settingsTypes::DataReplicationSettings

Indicates the settings of the data replication.



5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_idString

The identifier of the Directory Service directory for the WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_codeString

The error code that is returned if the WorkSpace cannot be created.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_messageString

The text of the error message that is returned if the WorkSpace cannot be created.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_addressString

The IP address of the WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_statesArray<Types::ModificationState>

The modification states of the WorkSpace.

Returns:



5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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

The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.



5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_enabledBoolean

Indicates whether the data stored on the root volume is encrypted.

Returns:

  • (Boolean)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_propertiesArray<Types::StandbyWorkspacesProperties>

The properties of the standby WorkSpace



5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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

#stateString

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 to UNHEALTHY 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.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_idString

The identifier of the subnet for the WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_nameString

The user for the WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_enabledBoolean

Indicates whether the data stored on the user volume is encrypted.

Returns:

  • (Boolean)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_keyString

The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_idString

The identifier of the WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_nameString

The name of the user-decoupled WorkSpace.

Returns:

  • (String)


5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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_propertiesTypes::WorkspaceProperties

The properties of the WorkSpace.



5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5580

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