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

Class: Aws::WorkSpaces::Types::Workspace

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about a WorkSpace.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle that the WorkSpace was created from.

Returns:

  • (String)

    The identifier of the bundle that the WorkSpace was created from.

#computer_nameString

The name of the WorkSpace as seen by the operating system.

Returns:

  • (String)

    The name of the WorkSpace as seen by the operating system.

#directory_idString

The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

Returns:

  • (String)

    The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

#error_codeString

If the WorkSpace could not be created, this contains the error code.

Returns:

  • (String)

    If the WorkSpace could not be created, this contains the error code.

#error_messageString

If the WorkSpace could not be created, this contains a textual error message that describes the failure.

Returns:

  • (String)

    If the WorkSpace could not be created, this contains a textual error message that describes the failure.

#ip_addressString

The IP address of the WorkSpace.

Returns:

  • (String)

    The IP address of the WorkSpace.

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

#stateString

The operational state of the WorkSpace.

Possible values:

  • PENDING
  • AVAILABLE
  • IMPAIRED
  • UNHEALTHY
  • REBOOTING
  • STARTING
  • REBUILDING
  • MAINTENANCE
  • TERMINATING
  • TERMINATED
  • SUSPENDED
  • STOPPING
  • STOPPED
  • ERROR

Returns:

  • (String)

    The operational state of the WorkSpace.

#subnet_idString

The identifier of the subnet that the WorkSpace is in.

Returns:

  • (String)

    The identifier of the subnet that the WorkSpace is in.

#user_nameString

The user that the WorkSpace is assigned to.

Returns:

  • (String)

    The user 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_idString

The identifier of the WorkSpace.

Returns:

  • (String)

    The identifier of the WorkSpace.

#workspace_propertiesTypes::WorkspaceProperties

Describes the properties of a WorkSpace.

Returns: