GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::WorkSpaces::RegisterWorkspaceDirectory(3) User Contributed Perl Documentation Paws::WorkSpaces::RegisterWorkspaceDirectory(3)

Paws::WorkSpaces::RegisterWorkspaceDirectory - Arguments for method RegisterWorkspaceDirectory on Paws::WorkSpaces

This class represents the parameters used for calling the method RegisterWorkspaceDirectory on the Amazon WorkSpaces service. Use the attributes of this class as arguments to method RegisterWorkspaceDirectory.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterWorkspaceDirectory.

    my $workspaces = Paws->service('WorkSpaces');
    my $RegisterWorkspaceDirectoryResult =
      $workspaces->RegisterWorkspaceDirectory(
      DirectoryId       => 'MyDirectoryId',
      EnableWorkDocs    => 1,
      EnableSelfService => 1,                 # OPTIONAL
      SubnetIds         => [
        'MySubnetId', ...                     # min: 15, max: 24
      ],    # OPTIONAL
      Tags => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 127
          Value => 'MyTagValue',    # max: 255; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      Tenancy => 'DEDICATED',    # OPTIONAL
      );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/workspaces/RegisterWorkspaceDirectory>

REQUIRED DirectoryId => Str

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.

Indicates whether self-service capabilities are enabled or disabled.

REQUIRED EnableWorkDocs => Bool

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.

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.

The tags associated with the directory.

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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).

Valid values are: "DEDICATED", "SHARED"

This class forms part of Paws, documenting arguments for method RegisterWorkspaceDirectory in Paws::WorkSpaces

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.