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,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Contains information about a WorkSpace creation request.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.

Returns:

  • (String)


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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 to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.

Returns:

  • (String)


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

Returns:

  • (Boolean)


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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 of the WorkSpace request.

Returns:



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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 that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member.

Returns:

  • (String)


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

Returns:

  • (Boolean)


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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)


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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

Describes the properties of a WorkSpace.



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1196

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