Class: Aws::WorkSpaces::Types::WorkspaceProperties

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

Overview

Describes a WorkSpace.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compute_type_name ⇒ String

The compute type. For more information, see [Amazon WorkSpaces Bundles].

[1]: aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles

Returns:

  • (String) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#global_accelerator ⇒ Types::GlobalAcceleratorForWorkSpace

Indicates the Global Accelerator properties.

Returns:



5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#operating_system_name ⇒ String

The name of the operating system.

Returns:

  • (String) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#protocols ⇒ Array<String>

The protocol. For more information, see [ Protocols for Amazon WorkSpaces].

<note markdown=“1”> * Only available for WorkSpaces created with PCoIP bundles.

  • The ‘Protocols` property is case sensitive. Ensure you use `PCOIP` or `DCV` (formerly WSP).

  • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html

Returns:

  • (Array<String>) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_size_gib ⇒ Integer

The size of the root volume. For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace].

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html

Returns:

  • (Integer) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#running_mode ⇒ String

The running mode. For more information, see [Manage the WorkSpace Running Mode].

<note markdown=“1”> The ‘MANUAL` value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see [Amazon WorkSpaces Core].

</note>

Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see [ Can I switch between hourly and monthly billing?]

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html [2]: aws.amazon.com/workspaces/core/ [3]: aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F

Returns:

  • (String) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#running_mode_auto_stop_timeout_in_minutes ⇒ Integer

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

Returns:

  • (Integer) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end

#user_volume_size_gib ⇒ Integer

The size of the user storage. For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace].

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html

Returns:

  • (Integer) 


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
 
# File 'lib/aws-sdk-workspaces/types.rb', line 5963

class WorkspaceProperties < Struct.new(
  :running_mode,
  :running_mode_auto_stop_timeout_in_minutes,
  :root_volume_size_gib,
  :user_volume_size_gib,
  :compute_type_name,
  :protocols,
  :operating_system_name,
  :global_accelerator)
  SENSITIVE = []
  include Aws::Structure
end