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
show all
Defined in:
(unknown)

Overview

Note:

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

Contains information about a WorkSpace creation request.

Returned by:

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)

    The identifier of the bundle to create the WorkSpace from.

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

    The identifier of the AWS Directory Service directory to create the WorkSpace in.

#root_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)

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

#tagsArray<Types::Tag>

The tags of the WorkSpace request.

Returns:

  • (Array<Types::Tag>)

    The tags of the WorkSpace request.

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

    The username that the WorkSpace is assigned to.

#user_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)

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

#volume_encryption_keyString

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

Returns:

  • (String)

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

#workspace_propertiesTypes::WorkspaceProperties

Describes the properties of a WorkSpace.

Returns: