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

Information about a WorkSpace.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The identifier of the bundle used to create the WorkSpace.

Returns:

  • (String)

    The identifier of the bundle used to create the WorkSpace.

#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 for the WorkSpace.

Returns:

  • (String)

    The identifier of the AWS Directory Service directory for the WorkSpace.

#error_codeString

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

Returns:

  • (String)

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

#error_messageString

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

Returns:

  • (String)

    If the WorkSpace could not be created, 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.

#modification_statesArray<Types::ModificationState>

The modification states of the WorkSpace.

Returns:

#root_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)

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

#stateString

The operational state of the WorkSpace.

Possible values:

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

Returns:

  • (String)

    The operational state of the WorkSpace.

#subnet_idString

The identifier of the subnet for the WorkSpace.

Returns:

  • (String)

    The identifier of the subnet for the WorkSpace.

#user_nameString

The user for the WorkSpace.

Returns:

  • (String)

    The user for the WorkSpace.

#user_volume_encryption_enabledBoolean

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

Returns:

  • (Boolean)

    Indicates whether the data stored on the user volume 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

The properties of the WorkSpace.

Returns: