blib/lib/Paws/WorkSpaces/WorkspaceCreationProperties.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::WorkSpaces::WorkspaceCreationProperties;
3 use Moose;
4 has CustomSecurityGroupId => (is => 'ro', isa => 'Str');
5 has DefaultOu => (is => 'ro', isa => 'Str');
6 has EnableInternetAccess => (is => 'ro', isa => 'Bool');
7 has EnableMaintenanceMode => (is => 'ro', isa => 'Bool');
8 has EnableWorkDocs => (is => 'ro', isa => 'Bool');
9 has UserEnabledAsLocalAdministrator => (is => 'ro', isa => 'Bool');
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::WorkSpaces::WorkspaceCreationProperties
18  
19 =head1 USAGE
20  
21 This class represents one of two things:
22  
23 =head3 Arguments in a call to a service
24  
25 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26 Each attribute should be used as a named argument in the calls that expect this type of object.
27  
28 As an example, if Att1 is expected to be a Paws::WorkSpaces::WorkspaceCreationProperties object:
29  
30 $service_obj->Method(Att1 => { CustomSecurityGroupId => $value, ..., UserEnabledAsLocalAdministrator => $value });
31  
32 =head3 Results returned from an API call
33  
34 Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::WorkspaceCreationProperties object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->CustomSecurityGroupId
38  
39 =head1 DESCRIPTION
40  
41 Describes the default properties that are used for creating WorkSpaces.
42 For more information, see Update Directory Details for Your WorkSpaces
43 (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html).
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 CustomSecurityGroupId => Str
49  
50 The identifier of your custom security group.
51  
52  
53 =head2 DefaultOu => Str
54  
55 The default organizational unit (OU) for your WorkSpaces directories.
56 This string must be the full Lightweight Directory Access Protocol
57 (LDAP) distinguished name for the target domain and OU. It must be in
58 the form C<"OU=I<value>,DC=I<value>,DC=I<value>">, where I<value> is
59 any string of characters, and the number of domain components (DCs) is
60 two or more. For example,
61 C<OU=WorkSpaces_machines,DC=machines,DC=example,DC=com>.
62  
63 =over
64  
65 =item *
66  
67 To avoid errors, certain characters in the distinguished name must be
68 escaped. For more information, see Distinguished Names
69 (https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names)
70 in the Microsoft documentation.
71  
72 =item *
73  
74 The API doesn't validate whether the OU exists.
75  
76 =back
77  
78  
79  
80 =head2 EnableInternetAccess => Bool
81  
82 Indicates whether internet access is enabled for your WorkSpaces.
83  
84  
85 =head2 EnableMaintenanceMode => Bool
86  
87 Indicates whether maintenance mode is enabled for your WorkSpaces. For
88 more information, see WorkSpace Maintenance
89 (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html).
90  
91  
92 =head2 EnableWorkDocs => Bool
93  
94 Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
95  
96 If WorkDocs is already enabled for a WorkSpaces directory and you
97 disable it, new WorkSpaces launched in the directory will not have
98 WorkDocs enabled. However, WorkDocs remains enabled for any existing
99 WorkSpaces, unless you either disable users' access to WorkDocs or you
100 delete the WorkDocs site. To disable users' access to WorkDocs, see
101 Disabling Users
102 (https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html)
103 in the I<Amazon WorkDocs Administration Guide>. To delete a WorkDocs
104 site, see Deleting a Site
105 (https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html)
106 in the I<Amazon WorkDocs Administration Guide>.
107  
108 If you enable WorkDocs on a directory that already has existing
109 WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are
110 launched in the directory will have WorkDocs enabled.
111  
112  
113 =head2 UserEnabledAsLocalAdministrator => Bool
114  
115 Indicates whether users are local administrators of their WorkSpaces.
116  
117  
118  
119 =head1 SEE ALSO
120  
121 This class forms part of L<Paws>, describing an object used in L<Paws::WorkSpaces>
122  
123 =head1 BUGS and CONTRIBUTIONS
124  
125 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
126  
127 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
128  
129 =cut
130