You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkSpaces::Types::WorkspaceRequest

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

Overview

Note:

When making an API call, you may pass WorkspaceRequest data as a hash:

{
  directory_id: "DirectoryId", # required
  user_name: "UserName", # required
  bundle_id: "BundleId", # required
  volume_encryption_key: "VolumeEncryptionKey",
  user_volume_encryption_enabled: false,
  root_volume_encryption_enabled: false,
  workspace_properties: {
    running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
    running_mode_auto_stop_timeout_in_minutes: 1,
    root_volume_size_gib: 1,
    user_volume_size_gib: 1,
    compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Information used to create a WorkSpace.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

Returns:

  • (String)


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#directory_idString

The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

Returns:

  • (String)


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#root_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags for the WorkSpace.

Returns:



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#user_nameString

The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.

Returns:

  • (String)


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#user_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#volume_encryption_keyString

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

Returns:

  • (String)


1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end

#workspace_propertiesTypes::WorkspaceProperties

The WorkSpace properties.



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1536

class WorkspaceRequest < Struct.new(
  :directory_id,
  :user_name,
  :bundle_id,
  :volume_encryption_key,
  :user_volume_encryption_enabled,
  :root_volume_encryption_enabled,
  :workspace_properties,
  :tags)
  include Aws::Structure
end