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

Class: Aws::WorkSpaces::Types::RegisterWorkspaceDirectoryRequest

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

Overview

Note:

When passing RegisterWorkspaceDirectoryRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  directory_id: "DirectoryId", # required
  subnet_ids: ["SubnetId"],
  enable_work_docs: false, # required
  enable_self_service: false,
  tenancy: "DEDICATED", # accepts DEDICATED, SHARED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#directory_id ⇒ String

The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

Returns:

  • (String) —

    The identifier of the directory.

#enable_self_service ⇒ Boolean

Indicates whether self-service capabilities are enabled or disabled.

Returns:

  • (Boolean) —

    Indicates whether self-service capabilities are enabled or disabled.

#enable_work_docs ⇒ Boolean

Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

Returns:

  • (Boolean) —

    Indicates whether Amazon WorkDocs is enabled or disabled.

#subnet_ids ⇒ Array<String>

The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

Returns:

  • (Array<String>) —

    The identifiers of the subnets for your virtual private cloud (VPC).

#tags ⇒ Array<Types::Tag>

The tags associated with the directory.

Returns:

  • (Array<Types::Tag>) —

    The tags associated with the directory.

#tenancy ⇒ String

Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.

Returns:

  • (String) —

    Indicates whether your WorkSpace directory is dedicated or shared.