File Coverage

blib/lib/Paws/WorkSpaces/WorkspaceDirectory.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::WorkSpaces::WorkspaceDirectory;
2 1     1   757 use Moose;
  1         3  
  1         11  
3             has Alias => (is => 'ro', isa => 'Str');
4             has CustomerUserName => (is => 'ro', isa => 'Str');
5             has DirectoryId => (is => 'ro', isa => 'Str');
6             has DirectoryName => (is => 'ro', isa => 'Str');
7             has DirectoryType => (is => 'ro', isa => 'Str');
8             has DnsIpAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9             has IamRoleId => (is => 'ro', isa => 'Str');
10             has RegistrationCode => (is => 'ro', isa => 'Str');
11             has State => (is => 'ro', isa => 'Str');
12             has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             has WorkspaceCreationProperties => (is => 'ro', isa => 'Paws::WorkSpaces::DefaultWorkspaceCreationProperties');
14             has WorkspaceSecurityGroupId => (is => 'ro', isa => 'Str');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::WorkSpaces::WorkspaceDirectory
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::WorkSpaces::WorkspaceDirectory object:
33              
34             $service_obj->Method(Att1 => { Alias => $value, ..., WorkspaceSecurityGroupId => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::WorkspaceDirectory object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->Alias
42              
43             =head1 DESCRIPTION
44              
45             Contains information about an AWS Directory Service directory for use
46             with Amazon WorkSpaces.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 Alias => Str
52              
53             The directory alias.
54              
55              
56             =head2 CustomerUserName => Str
57              
58             The user name for the service account.
59              
60              
61             =head2 DirectoryId => Str
62              
63             The directory identifier.
64              
65              
66             =head2 DirectoryName => Str
67              
68             The name of the directory.
69              
70              
71             =head2 DirectoryType => Str
72              
73             The directory type.
74              
75              
76             =head2 DnsIpAddresses => ArrayRef[Str|Undef]
77              
78             An array of strings that contains the IP addresses of the DNS servers
79             for the directory.
80              
81              
82             =head2 IamRoleId => Str
83              
84             The identifier of the IAM role. This is the role that allows Amazon
85             WorkSpaces to make calls to other services, such as Amazon EC2, on your
86             behalf.
87              
88              
89             =head2 RegistrationCode => Str
90              
91             The registration code for the directory. This is the code that users
92             enter in their Amazon WorkSpaces client application to connect to the
93             directory.
94              
95              
96             =head2 State => Str
97              
98             The state of the directory's registration with Amazon WorkSpaces
99              
100              
101             =head2 SubnetIds => ArrayRef[Str|Undef]
102              
103             An array of strings that contains the identifiers of the subnets used
104             with the directory.
105              
106              
107             =head2 WorkspaceCreationProperties => L<Paws::WorkSpaces::DefaultWorkspaceCreationProperties>
108              
109             A structure that specifies the default creation properties for all
110             WorkSpaces in the directory.
111              
112              
113             =head2 WorkspaceSecurityGroupId => Str
114              
115             The identifier of the security group that is assigned to new
116             WorkSpaces.
117              
118              
119              
120             =head1 SEE ALSO
121              
122             This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces>
123              
124             =head1 BUGS and CONTRIBUTIONS
125              
126             The source code is located here: https://github.com/pplu/aws-sdk-perl
127              
128             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
129              
130             =cut
131