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

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::WorkspaceProperties

Defined in:

gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a WorkSpace.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #compute_type_name ⇒ String

  The compute type.

• #global_accelerator ⇒ Types::GlobalAcceleratorForWorkSpace

  Indicates the Global Accelerator properties.

• #nested_virtualization_enabled ⇒ Boolean

  Specifies whether nested virtualization is enabled for the WorkSpace.

• #operating_system_name ⇒ String

  The name of the operating system.

• #protocols ⇒ Array<String>

  The protocol.

• #root_volume_size_gib ⇒ Integer

  The size of the root volume.

• #running_mode ⇒ String

  The running mode.

• #running_mode_auto_stop_timeout_in_minutes ⇒ Integer

  The time after a user logs off when WorkSpaces are automatically stopped.

• #user_volume_size_gib ⇒ Integer

  The size of the user storage.

Instance Attribute Details

#compute_type_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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

#global_accelerator ⇒ Types::GlobalAcceleratorForWorkSpace

Indicates the Global Accelerator properties.

Returns:

• (Types::GlobalAcceleratorForWorkSpace)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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

#nested_virtualization_enabled ⇒ Boolean

Specifies whether nested virtualization is enabled for the WorkSpace.

For more information, see Nested virtualization for Amazon WorkSpaces.

Returns:

• (Boolean)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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

#operating_system_name ⇒ String

The name of the operating system.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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

#protocols ⇒ Array<String>

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

* 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, GraphicsPro.g4dn, Graphics.g6, and Graphics.g7).

Returns:

• (Array<String>)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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,
  :nested_virtualization_enabled)
  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.

Returns:

• (Integer)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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

#running_mode ⇒ String

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

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.

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?

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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,
  :nested_virtualization_enabled)
  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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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,
  :nested_virtualization_enabled)
  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.

Returns:

• (Integer)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6237

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