blib/lib/Paws/RDS/RestoreDBClusterFromS3.pm untested

filter: Statementstmt 0.0% 0 / 40 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 42 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::RestoreDBClusterFromS3;
3 use Moose;
4 has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has BacktrackWindow => (is => 'ro', isa => 'Int');
6 has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
7 has CharacterSetName => (is => 'ro', isa => 'Str');
8 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
9 has DatabaseName => (is => 'ro', isa => 'Str');
10 has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
11 has DBClusterParameterGroupName => (is => 'ro', isa => 'Str');
12 has DBSubnetGroupName => (is => 'ro', isa => 'Str');
13 has DeletionProtection => (is => 'ro', isa => 'Bool');
14 has Domain => (is => 'ro', isa => 'Str');
15 has DomainIAMRoleName => (is => 'ro', isa => 'Str');
16 has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
17 has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
18 has Engine => (is => 'ro', isa => 'Str', required => 1);
19 has EngineVersion => (is => 'ro', isa => 'Str');
20 has KmsKeyId => (is => 'ro', isa => 'Str');
21 has MasterUsername => (is => 'ro', isa => 'Str', required => 1);
22 has MasterUserPassword => (is => 'ro', isa => 'Str', required => 1);
23 has OptionGroupName => (is => 'ro', isa => 'Str');
24 has Port => (is => 'ro', isa => 'Int');
25 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
26 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
27 has S3BucketName => (is => 'ro', isa => 'Str', required => 1);
28 has S3IngestionRoleArn => (is => 'ro', isa => 'Str', required => 1);
29 has S3Prefix => (is => 'ro', isa => 'Str');
30 has SourceEngine => (is => 'ro', isa => 'Str', required => 1);
31 has SourceEngineVersion => (is => 'ro', isa => 'Str', required => 1);
32 has StorageEncrypted => (is => 'ro', isa => 'Bool');
33 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
34 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
35  
36 use MooseX::ClassAttribute;
37  
38 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromS3');
39 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBClusterFromS3Result');
40 class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromS3Result');
41 1;
42  
43 ### main pod documentation begin ###
44  
45 =head1 NAME
46  
47 Paws::RDS::RestoreDBClusterFromS3 - Arguments for method RestoreDBClusterFromS3 on L<Paws::RDS>
48  
49 =head1 DESCRIPTION
50  
51 This class represents the parameters used for calling the method RestoreDBClusterFromS3 on the
52 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
53 as arguments to method RestoreDBClusterFromS3.
54  
55 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromS3.
56  
57 =head1 SYNOPSIS
58  
59 my $rds = Paws->service('RDS');
60 my $RestoreDBClusterFromS3Result = $rds->RestoreDBClusterFromS3(
61 DBClusterIdentifier => 'MyString',
62 Engine => 'MyString',
63 MasterUserPassword => 'MyString',
64 MasterUsername => 'MyString',
65 S3BucketName => 'MyString',
66 S3IngestionRoleArn => 'MyString',
67 SourceEngine => 'MyString',
68 SourceEngineVersion => 'MyString',
69 AvailabilityZones => [ 'MyString', ... ], # OPTIONAL
70 BacktrackWindow => 1, # OPTIONAL
71 BackupRetentionPeriod => 1, # OPTIONAL
72 CharacterSetName => 'MyString', # OPTIONAL
73 CopyTagsToSnapshot => 1, # OPTIONAL
74 DBClusterParameterGroupName => 'MyString', # OPTIONAL
75 DBSubnetGroupName => 'MyString', # OPTIONAL
76 DatabaseName => 'MyString', # OPTIONAL
77 DeletionProtection => 1, # OPTIONAL
78 Domain => 'MyString', # OPTIONAL
79 DomainIAMRoleName => 'MyString', # OPTIONAL
80 EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL
81 EnableIAMDatabaseAuthentication => 1, # OPTIONAL
82 EngineVersion => 'MyString', # OPTIONAL
83 KmsKeyId => 'MyString', # OPTIONAL
84 OptionGroupName => 'MyString', # OPTIONAL
85 Port => 1, # OPTIONAL
86 PreferredBackupWindow => 'MyString', # OPTIONAL
87 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
88 S3Prefix => 'MyString', # OPTIONAL
89 StorageEncrypted => 1, # OPTIONAL
90 Tags => [
91 {
92 Key => 'MyString',
93 Value => 'MyString',
94 },
95 ...
96 ], # OPTIONAL
97 VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL
98 );
99  
100 # Results:
101 my $DBCluster = $RestoreDBClusterFromS3Result->DBCluster;
102  
103 # Returns a L<Paws::RDS::RestoreDBClusterFromS3Result> object.
104  
105 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.
106 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterFromS3>
107  
108 =head1 ATTRIBUTES
109  
110  
111 =head2 AvailabilityZones => ArrayRef[Str|Undef]
112  
113 A list of Availability Zones (AZs) where instances in the restored DB
114 cluster can be created.
115  
116  
117  
118 =head2 BacktrackWindow => Int
119  
120 The target backtrack window, in seconds. To disable backtracking, set
121 this value to 0.
122  
123 Currently, Backtrack is only supported for Aurora MySQL DB clusters.
124  
125 Default: 0
126  
127 Constraints:
128  
129 =over
130  
131 =item *
132  
133 If specified, this value must be set to a number from 0 to 259,200 (72
134 hours).
135  
136 =back
137  
138  
139  
140  
141 =head2 BackupRetentionPeriod => Int
142  
143 The number of days for which automated backups of the restored DB
144 cluster are retained. You must specify a minimum value of 1.
145  
146 Default: 1
147  
148 Constraints:
149  
150 =over
151  
152 =item *
153  
154 Must be a value from 1 to 35
155  
156 =back
157  
158  
159  
160  
161 =head2 CharacterSetName => Str
162  
163 A value that indicates that the restored DB cluster should be
164 associated with the specified CharacterSet.
165  
166  
167  
168 =head2 CopyTagsToSnapshot => Bool
169  
170 A value that indicates whether to copy all tags from the restored DB
171 cluster to snapshots of the restored DB cluster. The default is not to
172 copy them.
173  
174  
175  
176 =head2 DatabaseName => Str
177  
178 The database name for the restored DB cluster.
179  
180  
181  
182 =head2 B<REQUIRED> DBClusterIdentifier => Str
183  
184 The name of the DB cluster to create from the source data in the Amazon
185 S3 bucket. This parameter isn't case-sensitive.
186  
187 Constraints:
188  
189 =over
190  
191 =item *
192  
193 Must contain from 1 to 63 letters, numbers, or hyphens.
194  
195 =item *
196  
197 First character must be a letter.
198  
199 =item *
200  
201 Can't end with a hyphen or contain two consecutive hyphens.
202  
203 =back
204  
205 Example: C<my-cluster1>
206  
207  
208  
209 =head2 DBClusterParameterGroupName => Str
210  
211 The name of the DB cluster parameter group to associate with the
212 restored DB cluster. If this argument is omitted, C<default.aurora5.6>
213 is used.
214  
215 Constraints:
216  
217 =over
218  
219 =item *
220  
221 If supplied, must match the name of an existing
222 DBClusterParameterGroup.
223  
224 =back
225  
226  
227  
228  
229 =head2 DBSubnetGroupName => Str
230  
231 A DB subnet group to associate with the restored DB cluster.
232  
233 Constraints: If supplied, must match the name of an existing
234 DBSubnetGroup.
235  
236 Example: C<mySubnetgroup>
237  
238  
239  
240 =head2 DeletionProtection => Bool
241  
242 A value that indicates whether the DB cluster has deletion protection
243 enabled. The database can't be deleted when deletion protection is
244 enabled. By default, deletion protection is disabled.
245  
246  
247  
248 =head2 Domain => Str
249  
250 Specify the Active Directory directory ID to restore the DB cluster in.
251 The domain must be created prior to this operation.
252  
253 For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
254 Authentication to authenticate users that connect to the DB cluster.
255 For more information, see Kerberos Authentication
256 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
257 in the I<Amazon Aurora User Guide>.
258  
259  
260  
261 =head2 DomainIAMRoleName => Str
262  
263 Specify the name of the IAM role to be used when making API calls to
264 the Directory Service.
265  
266  
267  
268 =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef]
269  
270 The list of logs that the restored DB cluster is to export to
271 CloudWatch Logs. The values in the list depend on the DB engine being
272 used. For more information, see Publishing Database Logs to Amazon
273 CloudWatch Logs
274 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
275 in the I<Amazon Aurora User Guide>.
276  
277  
278  
279 =head2 EnableIAMDatabaseAuthentication => Bool
280  
281 A value that indicates whether to enable mapping of Amazon Web Services
282 Identity and Access Management (IAM) accounts to database accounts. By
283 default, mapping is disabled.
284  
285 For more information, see IAM Database Authentication
286 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
287 in the I<Amazon Aurora User Guide.>
288  
289  
290  
291 =head2 B<REQUIRED> Engine => Str
292  
293 The name of the database engine to be used for this DB cluster.
294  
295 Valid Values: C<aurora> (for MySQL 5.6-compatible Aurora),
296 C<aurora-mysql> (for MySQL 5.7-compatible Aurora), and
297 C<aurora-postgresql>
298  
299  
300  
301 =head2 EngineVersion => Str
302  
303 The version number of the database engine to use.
304  
305 To list all of the available engine versions for C<aurora> (for MySQL
306 5.6-compatible Aurora), use the following command:
307  
308 C<aws rds describe-db-engine-versions --engine aurora --query
309 "DBEngineVersions[].EngineVersion">
310  
311 To list all of the available engine versions for C<aurora-mysql> (for
312 MySQL 5.7-compatible Aurora), use the following command:
313  
314 C<aws rds describe-db-engine-versions --engine aurora-mysql --query
315 "DBEngineVersions[].EngineVersion">
316  
317 To list all of the available engine versions for C<aurora-postgresql>,
318 use the following command:
319  
320 C<aws rds describe-db-engine-versions --engine aurora-postgresql
321 --query "DBEngineVersions[].EngineVersion">
322  
323 B<Aurora MySQL>
324  
325 Example: C<5.6.10a>, C<5.6.mysql_aurora.1.19.2>, C<5.7.12>,
326 C<5.7.mysql_aurora.2.04.5>
327  
328 B<Aurora PostgreSQL>
329  
330 Example: C<9.6.3>, C<10.7>
331  
332  
333  
334 =head2 KmsKeyId => Str
335  
336 The Amazon Web Services KMS key identifier for an encrypted DB cluster.
337  
338 The Amazon Web Services KMS key identifier is the key ARN, key ID,
339 alias ARN, or alias name for the Amazon Web Services KMS customer
340 master key (CMK). To use a CMK in a different Amazon Web Services
341 account, specify the key ARN or alias ARN.
342  
343 If the StorageEncrypted parameter is enabled, and you do not specify a
344 value for the C<KmsKeyId> parameter, then Amazon RDS will use your
345 default CMK. There is a default CMK for your Amazon Web Services
346 account. Your Amazon Web Services account has a different default CMK
347 for each Amazon Web Services Region.
348  
349  
350  
351 =head2 B<REQUIRED> MasterUsername => Str
352  
353 The name of the master user for the restored DB cluster.
354  
355 Constraints:
356  
357 =over
358  
359 =item *
360  
361 Must be 1 to 16 letters or numbers.
362  
363 =item *
364  
365 First character must be a letter.
366  
367 =item *
368  
369 Can't be a reserved word for the chosen database engine.
370  
371 =back
372  
373  
374  
375  
376 =head2 B<REQUIRED> MasterUserPassword => Str
377  
378 The password for the master database user. This password can contain
379 any printable ASCII character except "/", """, or "@".
380  
381 Constraints: Must contain from 8 to 41 characters.
382  
383  
384  
385 =head2 OptionGroupName => Str
386  
387 A value that indicates that the restored DB cluster should be
388 associated with the specified option group.
389  
390 Permanent options can't be removed from an option group. An option
391 group can't be removed from a DB cluster once it is associated with a
392 DB cluster.
393  
394  
395  
396 =head2 Port => Int
397  
398 The port number on which the instances in the restored DB cluster
399 accept connections.
400  
401 Default: C<3306>
402  
403  
404  
405 =head2 PreferredBackupWindow => Str
406  
407 The daily time range during which automated backups are created if
408 automated backups are enabled using the C<BackupRetentionPeriod>
409 parameter.
410  
411 The default is a 30-minute window selected at random from an 8-hour
412 block of time for each Amazon Web Services Region. To view the time
413 blocks available, see Backup window
414 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
415 in the I<Amazon Aurora User Guide.>
416  
417 Constraints:
418  
419 =over
420  
421 =item *
422  
423 Must be in the format C<hh24:mi-hh24:mi>.
424  
425 =item *
426  
427 Must be in Universal Coordinated Time (UTC).
428  
429 =item *
430  
431 Must not conflict with the preferred maintenance window.
432  
433 =item *
434  
435 Must be at least 30 minutes.
436  
437 =back
438  
439  
440  
441  
442 =head2 PreferredMaintenanceWindow => Str
443  
444 The weekly time range during which system maintenance can occur, in
445 Universal Coordinated Time (UTC).
446  
447 Format: C<ddd:hh24:mi-ddd:hh24:mi>
448  
449 The default is a 30-minute window selected at random from an 8-hour
450 block of time for each Amazon Web Services Region, occurring on a
451 random day of the week. To see the time blocks available, see Adjusting
452 the Preferred Maintenance Window
453 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
454 in the I<Amazon Aurora User Guide.>
455  
456 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
457  
458 Constraints: Minimum 30-minute window.
459  
460  
461  
462 =head2 B<REQUIRED> S3BucketName => Str
463  
464 The name of the Amazon S3 bucket that contains the data used to create
465 the Amazon Aurora DB cluster.
466  
467  
468  
469 =head2 B<REQUIRED> S3IngestionRoleArn => Str
470  
471 The Amazon Resource Name (ARN) of the Amazon Web Services Identity and
472 Access Management (IAM) role that authorizes Amazon RDS to access the
473 Amazon S3 bucket on your behalf.
474  
475  
476  
477 =head2 S3Prefix => Str
478  
479 The prefix for all of the file names that contain the data used to
480 create the Amazon Aurora DB cluster. If you do not specify a
481 B<SourceS3Prefix> value, then the Amazon Aurora DB cluster is created
482 by using all of the files in the Amazon S3 bucket.
483  
484  
485  
486 =head2 B<REQUIRED> SourceEngine => Str
487  
488 The identifier for the database engine that was backed up to create the
489 files stored in the Amazon S3 bucket.
490  
491 Valid values: C<mysql>
492  
493  
494  
495 =head2 B<REQUIRED> SourceEngineVersion => Str
496  
497 The version of the database that the backup files were created from.
498  
499 MySQL versions 5.5, 5.6, and 5.7 are supported.
500  
501 Example: C<5.6.40>, C<5.7.28>
502  
503  
504  
505 =head2 StorageEncrypted => Bool
506  
507 A value that indicates whether the restored DB cluster is encrypted.
508  
509  
510  
511 =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
512  
513  
514  
515  
516  
517 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
518  
519 A list of EC2 VPC security groups to associate with the restored DB
520 cluster.
521  
522  
523  
524  
525 =head1 SEE ALSO
526  
527 This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterFromS3 in L<Paws::RDS>
528  
529 =head1 BUGS and CONTRIBUTIONS
530  
531 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
532  
533 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
534  
535 =cut
536