blib/lib/Paws/FSX/CreateFileSystemWindowsConfiguration.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::FSX::CreateFileSystemWindowsConfiguration;
3 use Moose;
4 has ActiveDirectoryId => (is => 'ro', isa => 'Str');
5 has Aliases => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6 has AuditLogConfiguration => (is => 'ro', isa => 'Paws::FSX::WindowsAuditLogCreateConfiguration');
7 has AutomaticBackupRetentionDays => (is => 'ro', isa => 'Int');
8 has CopyTagsToBackups => (is => 'ro', isa => 'Bool');
9 has DailyAutomaticBackupStartTime => (is => 'ro', isa => 'Str');
10 has DeploymentType => (is => 'ro', isa => 'Str');
11 has PreferredSubnetId => (is => 'ro', isa => 'Str');
12 has SelfManagedActiveDirectoryConfiguration => (is => 'ro', isa => 'Paws::FSX::SelfManagedActiveDirectoryConfiguration');
13 has ThroughputCapacity => (is => 'ro', isa => 'Int', required => 1);
14 has WeeklyMaintenanceStartTime => (is => 'ro', isa => 'Str');
15  
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::FSX::CreateFileSystemWindowsConfiguration
23  
24 =head1 USAGE
25  
26 This class represents one of two things:
27  
28 =head3 Arguments in a call to a service
29  
30 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31 Each attribute should be used as a named argument in the calls that expect this type of object.
32  
33 As an example, if Att1 is expected to be a Paws::FSX::CreateFileSystemWindowsConfiguration object:
34  
35 $service_obj->Method(Att1 => { ActiveDirectoryId => $value, ..., WeeklyMaintenanceStartTime => $value });
36  
37 =head3 Results returned from an API call
38  
39 Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::CreateFileSystemWindowsConfiguration object:
40  
41 $result = $service_obj->Method(...);
42 $result->Att1->ActiveDirectoryId
43  
44 =head1 DESCRIPTION
45  
46 The configuration object for the Microsoft Windows file system used in
47 C<CreateFileSystem> and C<CreateFileSystemFromBackup> operations.
48  
49 =head1 ATTRIBUTES
50  
51  
52 =head2 ActiveDirectoryId => Str
53  
54 The ID for an existing AWS Managed Microsoft Active Directory (AD)
55 instance that the file system should join when it's created.
56  
57  
58 =head2 Aliases => ArrayRef[Str|Undef]
59  
60 An array of one or more DNS alias names that you want to associate with
61 the Amazon FSx file system. Aliases allow you to use existing DNS names
62 to access the data in your Amazon FSx file system. You can associate up
63 to 50 aliases with a file system at any time. You can associate
64 additional DNS aliases after you create the file system using the
65 AssociateFileSystemAliases operation. You can remove DNS aliases from
66 the file system after it is created using the
67 DisassociateFileSystemAliases operation. You only need to specify the
68 alias name in the request payload.
69  
70 For more information, see Working with DNS Aliases
71 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html)
72 and Walkthrough 5: Using DNS aliases to access your file system
73 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html),
74 including additional steps you must take to be able to access your file
75 system using a DNS alias.
76  
77 An alias name has to meet the following requirements:
78  
79 =over
80  
81 =item *
82  
83 Formatted as a fully-qualified domain name (FQDN), C<hostname.domain>,
84 for example, C<accounting.example.com>.
85  
86 =item *
87  
88 Can contain alphanumeric characters, the underscore (_), and the hyphen
89 (-).
90  
91 =item *
92  
93 Cannot start or end with a hyphen.
94  
95 =item *
96  
97 Can start with a numeric.
98  
99 =back
100  
101 For DNS alias names, Amazon FSx stores alphabetic characters as
102 lowercase letters (a-z), regardless of how you specify them: as
103 uppercase letters, lowercase letters, or the corresponding letters in
104 escape codes.
105  
106  
107 =head2 AuditLogConfiguration => L<Paws::FSX::WindowsAuditLogCreateConfiguration>
108  
109 The configuration that Amazon FSx for Windows File Server uses to audit
110 and log user accesses of files, folders, and file shares on the Amazon
111 FSx for Windows File Server file system.
112  
113  
114 =head2 AutomaticBackupRetentionDays => Int
115  
116 The number of days to retain automatic backups. The default is to
117 retain backups for 7 days. Setting this value to 0 disables the
118 creation of automatic backups. The maximum retention period for backups
119 is 90 days.
120  
121  
122 =head2 CopyTagsToBackups => Bool
123  
124 A boolean flag indicating whether tags for the file system should be
125 copied to backups. This value defaults to false. If it's set to true,
126 all tags for the file system are copied to all automatic and
127 user-initiated backups where the user doesn't specify tags. If this
128 value is true, and you specify one or more tags, only the specified
129 tags are copied to backups. If you specify one or more tags when
130 creating a user-initiated backup, no tags are copied from the file
131 system, regardless of this value.
132  
133  
134 =head2 DailyAutomaticBackupStartTime => Str
135  
136 The preferred time to take daily automatic backups, formatted HH:MM in
137 the UTC time zone.
138  
139  
140 =head2 DeploymentType => Str
141  
142 Specifies the file system deployment type, valid values are the
143 following:
144  
145 =over
146  
147 =item *
148  
149 C<MULTI_AZ_1> - Deploys a high availability file system that is
150 configured for Multi-AZ redundancy to tolerate temporary Availability
151 Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in
152 AWS Regions that have a minimum of three Availability Zones. Also
153 supports HDD storage type
154  
155 =item *
156  
157 C<SINGLE_AZ_1> - (Default) Choose to deploy a file system that is
158 configured for single AZ redundancy.
159  
160 =item *
161  
162 C<SINGLE_AZ_2> - The latest generation Single AZ file system. Specifies
163 a file system that is configured for single AZ redundancy and supports
164 HDD storage type.
165  
166 =back
167  
168 For more information, see Availability and Durability: Single-AZ and
169 Multi-AZ File Systems
170 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html).
171  
172  
173 =head2 PreferredSubnetId => Str
174  
175 Required when C<DeploymentType> is set to C<MULTI_AZ_1>. This specifies
176 the subnet in which you want the preferred file server to be located.
177 For in-AWS applications, we recommend that you launch your clients in
178 the same Availability Zone (AZ) as your preferred file server to reduce
179 cross-AZ data transfer costs and minimize latency.
180  
181  
182 =head2 SelfManagedActiveDirectoryConfiguration => L<Paws::FSX::SelfManagedActiveDirectoryConfiguration>
183  
184  
185  
186  
187 =head2 B<REQUIRED> ThroughputCapacity => Int
188  
189 The throughput of an Amazon FSx file system, measured in megabytes per
190 second, in 2 to the I<n>th increments, between 2^3 (8) and 2^11 (2048).
191  
192  
193 =head2 WeeklyMaintenanceStartTime => Str
194  
195 The preferred start time to perform weekly maintenance, formatted
196 d:HH:MM in the UTC time zone, where d is the weekday number, from 1
197 through 7, beginning with Monday and ending with Sunday.
198  
199  
200  
201 =head1 SEE ALSO
202  
203 This class forms part of L<Paws>, describing an object used in L<Paws::FSX>
204  
205 =head1 BUGS and CONTRIBUTIONS
206  
207 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
208  
209 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
210  
211 =cut
212