You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Contains information about a WorkSpace.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle that the WorkSpace was created from.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#computer_nameString

The name of the WorkSpace as seen by the operating system.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#directory_idString

The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#error_codeString

If the WorkSpace could not be created, this contains the error code.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#error_messageString

If the WorkSpace could not be created, this contains a textual error message that describes the failure.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#ip_addressString

The IP address of the WorkSpace.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#root_volume_encryption_enabledBoolean

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

Returns:

  • (Boolean)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#stateString

The operational state of the WorkSpace.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#subnet_idString

The identifier of the subnet that the WorkSpace is in.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#user_nameString

The user that the WorkSpace is assigned to.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#user_volume_encryption_enabledBoolean

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

Returns:

  • (Boolean)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#volume_encryption_keyString

The KMS key used to encrypt data stored on your WorkSpace.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#workspace_idString

The identifier of the WorkSpace.

Returns:

  • (String)


937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end

#workspace_propertiesTypes::WorkspaceProperties

Describes the properties of a WorkSpace.



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 937

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_properties)
  include Aws::Structure
end