You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::WorkSpaces::Types::WorkspaceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpaces::Types::WorkspaceRequest
- Defined in:
- (unknown)
Overview
When passing WorkspaceRequest as input to an Aws::Client method, you can use a vanilla 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, POWERPRO, GRAPHICSPRO
},
tags: [
{
key: "TagKey", # required
value: "TagValue",
},
],
}
Describes the information used to create a WorkSpace.
Returned by:
Instance Attribute Summary collapse
-
#bundle_id ⇒ String
The identifier of the bundle for the WorkSpace.
-
#directory_id ⇒ String
The identifier of the AWS Directory Service directory for the WorkSpace.
-
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
-
#tags ⇒ Array<Types::Tag>
The tags for the WorkSpace.
-
#user_name ⇒ String
The user name of the user for the WorkSpace.
-
#user_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the user volume is encrypted.
-
#volume_encryption_key ⇒ String
The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace.
-
#workspace_properties ⇒ Types::WorkspaceProperties
The WorkSpace properties.
Instance Attribute Details
#bundle_id ⇒ String
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
#directory_id ⇒ String
The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
#root_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the root volume is encrypted.
#tags ⇒ Array<Types::Tag>
The tags for the WorkSpace.
#user_name ⇒ String
The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace.
#user_volume_encryption_enabled ⇒ Boolean
Indicates whether the data stored on the user volume is encrypted.
#volume_encryption_key ⇒ String
The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
#workspace_properties ⇒ Types::WorkspaceProperties
The WorkSpace properties.