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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::FSX::CreateFileSystem;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has FileSystemType => (is => 'ro', isa => 'Str', required => 1);
6 has KmsKeyId => (is => 'ro', isa => 'Str');
7 has LustreConfiguration => (is => 'ro', isa => 'Paws::FSX::CreateFileSystemLustreConfiguration');
8 has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9 has StorageCapacity => (is => 'ro', isa => 'Int', required => 1);
10 has StorageType => (is => 'ro', isa => 'Str');
11 has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
12 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Tag]');
13 has WindowsConfiguration => (is => 'ro', isa => 'Paws::FSX::CreateFileSystemWindowsConfiguration');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFileSystem');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FSX::CreateFileSystemResponse');
19 class_has _result_key => (isa => 'Str', is => 'ro');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::FSX::CreateFileSystem - Arguments for method CreateFileSystem on L<Paws::FSX>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method CreateFileSystem on the
31 L<Amazon FSx|Paws::FSX> service. Use the attributes of this class
32 as arguments to method CreateFileSystem.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFileSystem.
35  
36 =head1 SYNOPSIS
37  
38 my $fsx = Paws->service('FSX');
39 my $CreateFileSystemResponse = $fsx->CreateFileSystem(
40 FileSystemType => 'WINDOWS',
41 StorageCapacity => 1,
42 SubnetIds => [
43 'MySubnetId', ... # min: 15, max: 24
44 ],
45 ClientRequestToken => 'MyClientRequestToken', # OPTIONAL
46 KmsKeyId => 'MyKmsKeyId', # OPTIONAL
47 LustreConfiguration => {
48 AutoImportPolicy => 'NONE', # values: NONE, NEW, NEW_CHANGED; OPTIONAL
49 AutomaticBackupRetentionDays => 1, # max: 90; OPTIONAL
50 CopyTagsToBackups => 1, # OPTIONAL
51 DailyAutomaticBackupStartTime =>
52 'MyDailyTime', # min: 5, max: 5; OPTIONAL
53 DataCompressionType => 'NONE', # values: NONE, LZ4; OPTIONAL
54 DeploymentType =>
55 'SCRATCH_1', # values: SCRATCH_1, SCRATCH_2, PERSISTENT_1; OPTIONAL
56 DriveCacheType => 'NONE', # values: NONE, READ; OPTIONAL
57 ExportPath => 'MyArchivePath', # min: 3, max: 4357; OPTIONAL
58 ImportPath => 'MyArchivePath', # min: 3, max: 4357; OPTIONAL
59 ImportedFileChunkSize => 1, # min: 1, max: 512000; OPTIONAL
60 PerUnitStorageThroughput => 1, # min: 12, max: 200; OPTIONAL
61 WeeklyMaintenanceStartTime => 'MyWeeklyTime', # min: 7, max: 7; OPTIONAL
62 }, # OPTIONAL
63 SecurityGroupIds => [
64 'MySecurityGroupId', ... # min: 11, max: 20
65 ], # OPTIONAL
66 StorageType => 'SSD', # OPTIONAL
67 Tags => [
68 {
69 Key => 'MyTagKey', # min: 1, max: 128
70 Value => 'MyTagValue', # max: 256
71  
72 },
73 ...
74 ], # OPTIONAL
75 WindowsConfiguration => {
76 ThroughputCapacity => 1, # min: 8, max: 2048
77 ActiveDirectoryId => 'MyDirectoryId', # min: 12, max: 12; OPTIONAL
78 Aliases => [
79 'MyAlternateDNSName', ... # min: 4, max: 253
80 ], # max: 50; OPTIONAL
81 AuditLogConfiguration => {
82 FileAccessAuditLogLevel => 'DISABLED'
83 , # values: DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
84 FileShareAccessAuditLogLevel => 'DISABLED'
85 , # values: DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
86 AuditLogDestination => 'MyGeneralARN', # min: 8, max: 1024; OPTIONAL
87 }, # OPTIONAL
88 AutomaticBackupRetentionDays => 1, # max: 90; OPTIONAL
89 CopyTagsToBackups => 1, # OPTIONAL
90 DailyAutomaticBackupStartTime =>
91 'MyDailyTime', # min: 5, max: 5; OPTIONAL
92 DeploymentType =>
93 'MULTI_AZ_1', # values: MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2; OPTIONAL
94 PreferredSubnetId => 'MySubnetId', # min: 15, max: 24
95 SelfManagedActiveDirectoryConfiguration => {
96 DnsIps => [
97 'MyIpAddress', ... # min: 7, max: 15
98 ], # min: 1, max: 2
99 DomainName =>
100 'MyActiveDirectoryFullyQualifiedName', # min: 1, max: 255
101 Password => 'MyDirectoryPassword', # min: 1, max: 256
102 UserName => 'MyDirectoryUserName', # min: 1, max: 256
103 FileSystemAdministratorsGroup =>
104 'MyFileSystemAdministratorsGroupName', # min: 1, max: 256; OPTIONAL
105 OrganizationalUnitDistinguishedName =>
106 'MyOrganizationalUnitDistinguishedName'
107 , # min: 1, max: 2000; OPTIONAL
108 }, # OPTIONAL
109 WeeklyMaintenanceStartTime => 'MyWeeklyTime', # min: 7, max: 7; OPTIONAL
110 }, # OPTIONAL
111 );
112  
113 # Results:
114 my $FileSystem = $CreateFileSystemResponse->FileSystem;
115  
116 # Returns a L<Paws::FSX::CreateFileSystemResponse> object.
117  
118 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.
119 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fsx/CreateFileSystem>
120  
121 =head1 ATTRIBUTES
122  
123  
124 =head2 ClientRequestToken => Str
125  
126 A string of up to 64 ASCII characters that Amazon FSx uses to ensure
127 idempotent creation. This string is automatically filled on your behalf
128 when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
129  
130  
131  
132 =head2 B<REQUIRED> FileSystemType => Str
133  
134 The type of Amazon FSx file system to create, either C<WINDOWS> or
135 C<LUSTRE>.
136  
137 Valid values are: C<"WINDOWS">, C<"LUSTRE">
138  
139 =head2 KmsKeyId => Str
140  
141  
142  
143  
144  
145 =head2 LustreConfiguration => L<Paws::FSX::CreateFileSystemLustreConfiguration>
146  
147  
148  
149  
150  
151 =head2 SecurityGroupIds => ArrayRef[Str|Undef]
152  
153 A list of IDs specifying the security groups to apply to all network
154 interfaces created for file system access. This list isn't returned in
155 later requests to describe the file system.
156  
157  
158  
159 =head2 B<REQUIRED> StorageCapacity => Int
160  
161 Sets the storage capacity of the file system that you're creating.
162  
163 For Lustre file systems:
164  
165 =over
166  
167 =item *
168  
169 For C<SCRATCH_2> and C<PERSISTENT_1 SSD> deployment types, valid values
170 are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
171  
172 =item *
173  
174 For C<PERSISTENT HDD> file systems, valid values are increments of 6000
175 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40
176 MB/s/TiB file systems.
177  
178 =item *
179  
180 For C<SCRATCH_1> deployment type, valid values are 1200 GiB, 2400 GiB,
181 and increments of 3600 GiB.
182  
183 =back
184  
185 For Windows file systems:
186  
187 =over
188  
189 =item *
190  
191 If C<StorageType=SSD>, valid values are 32 GiB - 65,536 GiB (64 TiB).
192  
193 =item *
194  
195 If C<StorageType=HDD>, valid values are 2000 GiB - 65,536 GiB (64 TiB).
196  
197 =back
198  
199  
200  
201  
202 =head2 StorageType => Str
203  
204 Sets the storage type for the file system you're creating. Valid values
205 are C<SSD> and C<HDD>.
206  
207 =over
208  
209 =item *
210  
211 Set to C<SSD> to use solid state drive storage. SSD is supported on all
212 Windows and Lustre deployment types.
213  
214 =item *
215  
216 Set to C<HDD> to use hard disk drive storage. HDD is supported on
217 C<SINGLE_AZ_2> and C<MULTI_AZ_1> Windows file system deployment types,
218 and on C<PERSISTENT> Lustre file system deployment types.
219  
220 =back
221  
222 Default value is C<SSD>. For more information, see Storage Type Options
223 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options)
224 in the I<Amazon FSx for Windows User Guide> and Multiple Storage
225 Options
226 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options)
227 in the I<Amazon FSx for Lustre User Guide>.
228  
229 Valid values are: C<"SSD">, C<"HDD">
230  
231 =head2 B<REQUIRED> SubnetIds => ArrayRef[Str|Undef]
232  
233 Specifies the IDs of the subnets that the file system will be
234 accessible from. For Windows C<MULTI_AZ_1> file system deployment
235 types, provide exactly two subnet IDs, one for the preferred file
236 server and one for the standby file server. You specify one of these
237 subnets as the preferred subnet using the C<WindowsConfiguration E<gt>
238 PreferredSubnetID> property. For more information, see Availability and
239 durability: Single-AZ and Multi-AZ file systems
240 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html).
241  
242 For Windows C<SINGLE_AZ_1> and C<SINGLE_AZ_2> file system deployment
243 types and Lustre file systems, provide exactly one subnet ID. The file
244 server is launched in that subnet's Availability Zone.
245  
246  
247  
248 =head2 Tags => ArrayRef[L<Paws::FSX::Tag>]
249  
250 The tags to apply to the file system being created. The key value of
251 the C<Name> tag appears in the console as the file system name.
252  
253  
254  
255 =head2 WindowsConfiguration => L<Paws::FSX::CreateFileSystemWindowsConfiguration>
256  
257 The Microsoft Windows configuration for the file system being created.
258  
259  
260  
261  
262 =head1 SEE ALSO
263  
264 This class forms part of L<Paws>, documenting arguments for method CreateFileSystem in L<Paws::FSX>
265  
266 =head1 BUGS and CONTRIBUTIONS
267  
268 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
269  
270 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
271  
272 =cut
273