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

Information about a WorkSpace.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle used to create the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#computer_nameString

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

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#directory_idString

The identifier of the AWS Directory Service directory for the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#error_codeString

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

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#error_messageString

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

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#ip_addressString

The IP address of the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#modification_statesArray<Types::ModificationState>

The modification states of the WorkSpace.

Returns:



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#root_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#stateString

The operational state of the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#subnet_idString

The identifier of the subnet for the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#user_nameString

The user for the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#user_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#volume_encryption_keyString

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

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#workspace_idString

The identifier of the WorkSpace.

Returns:

  • (String)


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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

#workspace_propertiesTypes::WorkspaceProperties

The properties of the WorkSpace.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1239

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