« blib/lib/Paws/WorkSpaces/WorkspaceCreationProperties.pm
↑ Summary
blib/lib/Paws/WorkSpaces/WorkspaceImage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WorkSpaces::WorkspaceDirectory; | ||
| 3 | use Moose; | ||
| 4 | has Alias => (is => 'ro', isa => 'Str'); | ||
| 5 | has CustomerUserName => (is => 'ro', isa => 'Str'); | ||
| 6 | has DirectoryId => (is => 'ro', isa => 'Str'); | ||
| 7 | has DirectoryName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DirectoryType => (is => 'ro', isa => 'Str'); | ||
| 9 | has DnsIpAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has IamRoleId => (is => 'ro', isa => 'Str'); | ||
| 11 | has IpGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ipGroupIds', traits => ['NameInRequest']); | ||
| 12 | has RegistrationCode => (is => 'ro', isa => 'Str'); | ||
| 13 | has SelfservicePermissions => (is => 'ro', isa => 'Paws::WorkSpaces::SelfservicePermissions'); | ||
| 14 | has State => (is => 'ro', isa => 'Str'); | ||
| 15 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 16 | has Tenancy => (is => 'ro', isa => 'Str'); | ||
| 17 | has WorkspaceAccessProperties => (is => 'ro', isa => 'Paws::WorkSpaces::WorkspaceAccessProperties'); | ||
| 18 | has WorkspaceCreationProperties => (is => 'ro', isa => 'Paws::WorkSpaces::DefaultWorkspaceCreationProperties'); | ||
| 19 | has WorkspaceSecurityGroupId => (is => 'ro', isa => 'Str'); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::WorkSpaces::WorkspaceDirectory | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::WorkSpaces::WorkspaceDirectory object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { Alias => $value, ..., WorkspaceSecurityGroupId => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::WorkspaceDirectory object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->Alias | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | Describes a directory that is used with Amazon WorkSpaces. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Alias => Str | ||
| 57 | |||
| 58 | The directory alias. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 CustomerUserName => Str | ||
| 62 | |||
| 63 | The user name for the service account. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 DirectoryId => Str | ||
| 67 | |||
| 68 | The directory identifier. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 DirectoryName => Str | ||
| 72 | |||
| 73 | The name of the directory. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 DirectoryType => Str | ||
| 77 | |||
| 78 | The directory type. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 DnsIpAddresses => ArrayRef[Str|Undef] | ||
| 82 | |||
| 83 | The IP addresses of the DNS servers for the directory. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 IamRoleId => Str | ||
| 87 | |||
| 88 | The identifier of the IAM role. This is the role that allows Amazon | ||
| 89 | WorkSpaces to make calls to other services, such as Amazon EC2, on your | ||
| 90 | behalf. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 IpGroupIds => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | The identifiers of the IP access control groups associated with the | ||
| 96 | directory. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 RegistrationCode => Str | ||
| 100 | |||
| 101 | The registration code for the directory. This is the code that users | ||
| 102 | enter in their Amazon WorkSpaces client application to connect to the | ||
| 103 | directory. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 SelfservicePermissions => L<Paws::WorkSpaces::SelfservicePermissions> | ||
| 107 | |||
| 108 | The default self-service permissions for WorkSpaces in the directory. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 State => Str | ||
| 112 | |||
| 113 | The state of the directory's registration with Amazon WorkSpaces. After | ||
| 114 | a directory is deregistered, the C<DEREGISTERED> state is returned very | ||
| 115 | briefly before the directory metadata is cleaned up, so this state is | ||
| 116 | rarely returned. To confirm that a directory is deregistered, check for | ||
| 117 | the directory ID by using DescribeWorkspaceDirectories | ||
| 118 | (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html). | ||
| 119 | If the directory ID isn't returned, then the directory has been | ||
| 120 | successfully deregistered. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 SubnetIds => ArrayRef[Str|Undef] | ||
| 124 | |||
| 125 | The identifiers of the subnets used with the directory. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 Tenancy => Str | ||
| 129 | |||
| 130 | Specifies whether the directory is dedicated or shared. To use Bring | ||
| 131 | Your Own License (BYOL), this value must be set to C<DEDICATED>. For | ||
| 132 | more information, see Bring Your Own Windows Desktop Images | ||
| 133 | (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). | ||
| 134 | |||
| 135 | |||
| 136 | =head2 WorkspaceAccessProperties => L<Paws::WorkSpaces::WorkspaceAccessProperties> | ||
| 137 | |||
| 138 | The devices and operating systems that users can use to access | ||
| 139 | WorkSpaces. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 WorkspaceCreationProperties => L<Paws::WorkSpaces::DefaultWorkspaceCreationProperties> | ||
| 143 | |||
| 144 | The default creation properties for all WorkSpaces in the directory. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 WorkspaceSecurityGroupId => Str | ||
| 148 | |||
| 149 | The identifier of the security group that is assigned to new | ||
| 150 | WorkSpaces. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head1 SEE ALSO | ||
| 155 | |||
| 156 | This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces> | ||
| 157 | |||
| 158 | =head1 BUGS and CONTRIBUTIONS | ||
| 159 | |||
| 160 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 161 | |||
| 162 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 163 | |||
| 164 | =cut | ||
| 165 |