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)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  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)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#directory_idString

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

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#error_codeString

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

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

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

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#ip_addressString

The IP address of the WorkSpace.

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#modification_statesArray<Types::ModificationState>

The modification states of the WorkSpace.

Returns:



3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The operational state of the WorkSpace.

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)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idString

The identifier of the subnet for the WorkSpace.

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

The user for the WorkSpace.

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#user_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#volume_encryption_keyString

The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_idString

The identifier of the WorkSpace.

Returns:

  • (String)


3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_propertiesTypes::WorkspaceProperties

The properties of the WorkSpace.



3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3005

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)
  SENSITIVE = []
  include Aws::Structure
end