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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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.

• #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].

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

Returns:

• (String)

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

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

#operating_system_name ⇒ String

The name of the operating system.

Returns:

• (String)

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

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

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

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

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

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html [2]: aws.amazon.com/workspaces/core/

Returns:

• (String)

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

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)
  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 'lib/aws-sdk-workspaces/types.rb', line 5135

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

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

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