« blib/lib/Paws/WorkSpaces/RebuildWorkspacesResult.pm
↑ Summary
blib/lib/Paws/WorkSpaces/RegisterWorkspaceDirectoryResult.pm »
| 1 | |||
| 2 | package Paws::WorkSpaces::RegisterWorkspaceDirectory; | ||
| 3 | use Moose; | ||
| 4 | has DirectoryId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EnableSelfService => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EnableWorkDocs => (is => 'ro', isa => 'Bool', required => 1); | ||
| 7 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::WorkSpaces::Tag]'); | ||
| 9 | has Tenancy => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterWorkspaceDirectory'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkSpaces::RegisterWorkspaceDirectoryResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::WorkSpaces::RegisterWorkspaceDirectory - Arguments for method RegisterWorkspaceDirectory on L<Paws::WorkSpaces> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method RegisterWorkspaceDirectory on the | ||
| 27 | L<Amazon WorkSpaces|Paws::WorkSpaces> service. Use the attributes of this class | ||
| 28 | as arguments to method RegisterWorkspaceDirectory. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterWorkspaceDirectory. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $workspaces = Paws->service('WorkSpaces'); | ||
| 35 | my $RegisterWorkspaceDirectoryResult = | ||
| 36 | $workspaces->RegisterWorkspaceDirectory( | ||
| 37 | DirectoryId => 'MyDirectoryId', | ||
| 38 | EnableWorkDocs => 1, | ||
| 39 | EnableSelfService => 1, # OPTIONAL | ||
| 40 | SubnetIds => [ | ||
| 41 | 'MySubnetId', ... # min: 15, max: 24 | ||
| 42 | ], # OPTIONAL | ||
| 43 | Tags => [ | ||
| 44 | { | ||
| 45 | Key => 'MyTagKey', # min: 1, max: 127 | ||
| 46 | Value => 'MyTagValue', # max: 255; OPTIONAL | ||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | Tenancy => 'DEDICATED', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workspaces/RegisterWorkspaceDirectory> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> DirectoryId => Str | ||
| 60 | |||
| 61 | The identifier of the directory. You cannot register a directory if it | ||
| 62 | does not have a status of Active. If the directory does not have a | ||
| 63 | status of Active, you will receive an InvalidResourceStateException | ||
| 64 | error. If you have already registered the maximum number of directories | ||
| 65 | that you can register with Amazon WorkSpaces, you will receive a | ||
| 66 | ResourceLimitExceededException error. Deregister directories that you | ||
| 67 | are not using for WorkSpaces, and try again. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 EnableSelfService => Bool | ||
| 72 | |||
| 73 | Indicates whether self-service capabilities are enabled or disabled. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> EnableWorkDocs => Bool | ||
| 78 | |||
| 79 | Indicates whether Amazon WorkDocs is enabled or disabled. If you have | ||
| 80 | enabled this parameter and WorkDocs is not available in the Region, you | ||
| 81 | will receive an OperationNotSupportedException error. Set | ||
| 82 | C<EnableWorkDocs> to disabled, and try again. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 SubnetIds => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | The identifiers of the subnets for your virtual private cloud (VPC). | ||
| 89 | Make sure that the subnets are in supported Availability Zones. The | ||
| 90 | subnets must also be in separate Availability Zones. If these | ||
| 91 | conditions are not met, you will receive an | ||
| 92 | OperationNotSupportedException error. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 Tags => ArrayRef[L<Paws::WorkSpaces::Tag>] | ||
| 97 | |||
| 98 | The tags associated with the directory. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Tenancy => Str | ||
| 103 | |||
| 104 | Indicates whether your WorkSpace directory is dedicated or shared. To | ||
| 105 | use Bring Your Own License (BYOL) images, this value must be set to | ||
| 106 | C<DEDICATED> and your AWS account must be enabled for BYOL. If your | ||
| 107 | account has not been enabled for BYOL, you will receive an | ||
| 108 | InvalidParameterValuesException error. For more information about BYOL | ||
| 109 | images, see Bring Your Own Windows Desktop Images | ||
| 110 | (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). | ||
| 111 | |||
| 112 | Valid values are: C<"DEDICATED">, C<"SHARED"> | ||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, documenting arguments for method RegisterWorkspaceDirectory in L<Paws::WorkSpaces> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |