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

filter: Statementstmt 0.0% 0 / 43 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 45 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::RestoreDBInstanceToPointInTime;
3 use Moose;
4 has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
5 has AvailabilityZone => (is => 'ro', isa => 'Str');
6 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
7 has DBInstanceClass => (is => 'ro', isa => 'Str');
8 has DBName => (is => 'ro', isa => 'Str');
9 has DBParameterGroupName => (is => 'ro', isa => 'Str');
10 has DBSubnetGroupName => (is => 'ro', isa => 'Str');
11 has DeletionProtection => (is => 'ro', isa => 'Bool');
12 has Domain => (is => 'ro', isa => 'Str');
13 has DomainIAMRoleName => (is => 'ro', isa => 'Str');
14 has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
15 has EnableCustomerOwnedIp => (is => 'ro', isa => 'Bool');
16 has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
17 has Engine => (is => 'ro', isa => 'Str');
18 has Iops => (is => 'ro', isa => 'Int');
19 has LicenseModel => (is => 'ro', isa => 'Str');
20 has MaxAllocatedStorage => (is => 'ro', isa => 'Int');
21 has MultiAZ => (is => 'ro', isa => 'Bool');
22 has OptionGroupName => (is => 'ro', isa => 'Str');
23 has Port => (is => 'ro', isa => 'Int');
24 has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]');
25 has PubliclyAccessible => (is => 'ro', isa => 'Bool');
26 has RestoreTime => (is => 'ro', isa => 'Str');
27 has SourceDBInstanceAutomatedBackupsArn => (is => 'ro', isa => 'Str');
28 has SourceDBInstanceIdentifier => (is => 'ro', isa => 'Str');
29 has SourceDbiResourceId => (is => 'ro', isa => 'Str');
30 has StorageType => (is => 'ro', isa => 'Str');
31 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
32 has TargetDBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
33 has TdeCredentialArn => (is => 'ro', isa => 'Str');
34 has TdeCredentialPassword => (is => 'ro', isa => 'Str');
35 has UseDefaultProcessorFeatures => (is => 'ro', isa => 'Bool');
36 has UseLatestRestorableTime => (is => 'ro', isa => 'Bool');
37 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
38  
39 use MooseX::ClassAttribute;
40  
41 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBInstanceToPointInTime');
42 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBInstanceToPointInTimeResult');
43 class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBInstanceToPointInTimeResult');
44 1;
45  
46 ### main pod documentation begin ###
47  
48 =head1 NAME
49  
50 Paws::RDS::RestoreDBInstanceToPointInTime - Arguments for method RestoreDBInstanceToPointInTime on L<Paws::RDS>
51  
52 =head1 DESCRIPTION
53  
54 This class represents the parameters used for calling the method RestoreDBInstanceToPointInTime on the
55 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
56 as arguments to method RestoreDBInstanceToPointInTime.
57  
58 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBInstanceToPointInTime.
59  
60 =head1 SYNOPSIS
61  
62 my $rds = Paws->service('RDS');
63 # To restore a DB instance to a point in time.
64 # The following example restores a DB instance to a new DB instance at a point
65 # in time from the source DB instance.
66 my $RestoreDBInstanceToPointInTimeResult =
67 $rds->RestoreDBInstanceToPointInTime(
68 'RestoreTime' => '2016-09-13T18:45:00Z',
69 'SourceDBInstanceIdentifier' => 'mysql-sample',
70 'TargetDBInstanceIdentifier' => 'mysql-sample-restored'
71 );
72  
73 # Results:
74 my $DBInstance = $RestoreDBInstanceToPointInTimeResult->DBInstance;
75  
76 # Returns a L<Paws::RDS::RestoreDBInstanceToPointInTimeResult> object.
77  
78 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.
79 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBInstanceToPointInTime>
80  
81 =head1 ATTRIBUTES
82  
83  
84 =head2 AutoMinorVersionUpgrade => Bool
85  
86 A value that indicates whether minor version upgrades are applied
87 automatically to the DB instance during the maintenance window.
88  
89  
90  
91 =head2 AvailabilityZone => Str
92  
93 The Availability Zone (AZ) where the DB instance will be created.
94  
95 Default: A random, system-chosen Availability Zone.
96  
97 Constraint: You can't specify the C<AvailabilityZone> parameter if the
98 DB instance is a Multi-AZ deployment.
99  
100 Example: C<us-east-1a>
101  
102  
103  
104 =head2 CopyTagsToSnapshot => Bool
105  
106 A value that indicates whether to copy all tags from the restored DB
107 instance to snapshots of the DB instance. By default, tags are not
108 copied.
109  
110  
111  
112 =head2 DBInstanceClass => Str
113  
114 The compute and memory capacity of the Amazon RDS DB instance, for
115 example, C<db.m4.large>. Not all DB instance classes are available in
116 all Amazon Web Services Regions, or for all database engines. For the
117 full list of DB instance classes, and availability for your engine, see
118 DB Instance Class
119 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
120 in the I<Amazon RDS User Guide.>
121  
122 Default: The same DBInstanceClass as the original DB instance.
123  
124  
125  
126 =head2 DBName => Str
127  
128 The database name for the restored DB instance.
129  
130 This parameter isn't used for the MySQL or MariaDB engines.
131  
132  
133  
134 =head2 DBParameterGroupName => Str
135  
136 The name of the DB parameter group to associate with this DB instance.
137  
138 If you do not specify a value for C<DBParameterGroupName>, then the
139 default C<DBParameterGroup> for the specified DB engine is used.
140  
141 Constraints:
142  
143 =over
144  
145 =item *
146  
147 If supplied, must match the name of an existing DBParameterGroup.
148  
149 =item *
150  
151 Must be 1 to 255 letters, numbers, or hyphens.
152  
153 =item *
154  
155 First character must be a letter.
156  
157 =item *
158  
159 Can't end with a hyphen or contain two consecutive hyphens.
160  
161 =back
162  
163  
164  
165  
166 =head2 DBSubnetGroupName => Str
167  
168 The DB subnet group name to use for the new instance.
169  
170 Constraints: If supplied, must match the name of an existing
171 DBSubnetGroup.
172  
173 Example: C<mySubnetgroup>
174  
175  
176  
177 =head2 DeletionProtection => Bool
178  
179 A value that indicates whether the DB instance has deletion protection
180 enabled. The database can't be deleted when deletion protection is
181 enabled. By default, deletion protection is disabled. For more
182 information, see Deleting a DB Instance
183 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
184  
185  
186  
187 =head2 Domain => Str
188  
189 Specify the Active Directory directory ID to restore the DB instance
190 in. The domain must be created prior to this operation. Currently, only
191 MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be
192 created in an Active Directory Domain.
193  
194 For more information, see Kerberos Authentication
195 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
196 in the I<Amazon RDS User Guide>.
197  
198  
199  
200 =head2 DomainIAMRoleName => Str
201  
202 Specify the name of the IAM role to be used when making API calls to
203 the Directory Service.
204  
205  
206  
207 =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef]
208  
209 The list of logs that the restored DB instance is to export to
210 CloudWatch Logs. The values in the list depend on the DB engine being
211 used. For more information, see Publishing Database Logs to Amazon
212 CloudWatch Logs
213 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
214 in the I<Amazon RDS User Guide>.
215  
216  
217  
218 =head2 EnableCustomerOwnedIp => Bool
219  
220 A value that indicates whether to enable a customer-owned IP address
221 (CoIP) for an RDS on Outposts DB instance.
222  
223 A I<CoIP> provides local or external connectivity to resources in your
224 Outpost subnets through your on-premises network. For some use cases, a
225 CoIP can provide lower latency for connections to the DB instance from
226 outside of its virtual private cloud (VPC) on your local network.
227  
228 For more information about RDS on Outposts, see Working with Amazon RDS
229 on Amazon Web Services Outposts
230 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
231 in the I<Amazon RDS User Guide>.
232  
233 For more information about CoIPs, see Customer-owned IP addresses
234 (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
235 in the I<Amazon Web Services Outposts User Guide>.
236  
237  
238  
239 =head2 EnableIAMDatabaseAuthentication => Bool
240  
241 A value that indicates whether to enable mapping of Amazon Web Services
242 Identity and Access Management (IAM) accounts to database accounts. By
243 default, mapping is disabled.
244  
245 For more information about IAM database authentication, see IAM
246 Database Authentication for MySQL and PostgreSQL
247 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
248 in the I<Amazon RDS User Guide.>
249  
250  
251  
252 =head2 Engine => Str
253  
254 The database engine to use for the new instance.
255  
256 Default: The same as source
257  
258 Constraint: Must be compatible with the engine of the source
259  
260 Valid Values:
261  
262 =over
263  
264 =item *
265  
266 C<mariadb>
267  
268 =item *
269  
270 C<mysql>
271  
272 =item *
273  
274 C<oracle-ee>
275  
276 =item *
277  
278 C<oracle-ee-cdb>
279  
280 =item *
281  
282 C<oracle-se2>
283  
284 =item *
285  
286 C<oracle-se2-cdb>
287  
288 =item *
289  
290 C<postgres>
291  
292 =item *
293  
294 C<sqlserver-ee>
295  
296 =item *
297  
298 C<sqlserver-se>
299  
300 =item *
301  
302 C<sqlserver-ex>
303  
304 =item *
305  
306 C<sqlserver-web>
307  
308 =back
309  
310  
311  
312  
313 =head2 Iops => Int
314  
315 The amount of Provisioned IOPS (input/output operations per second) to
316 be initially allocated for the DB instance.
317  
318 Constraints: Must be an integer greater than 1000.
319  
320 B<SQL Server>
321  
322 Setting the IOPS value for the SQL Server database engine isn't
323 supported.
324  
325  
326  
327 =head2 LicenseModel => Str
328  
329 License model information for the restored DB instance.
330  
331 Default: Same as source.
332  
333 Valid values: C<license-included> | C<bring-your-own-license> |
334 C<general-public-license>
335  
336  
337  
338 =head2 MaxAllocatedStorage => Int
339  
340 The upper limit to which Amazon RDS can automatically scale the storage
341 of the DB instance.
342  
343 For more information about this setting, including limitations that
344 apply to it, see Managing capacity automatically with Amazon RDS
345 storage autoscaling
346 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
347 in the I<Amazon RDS User Guide>.
348  
349  
350  
351 =head2 MultiAZ => Bool
352  
353 A value that indicates whether the DB instance is a Multi-AZ
354 deployment.
355  
356 Constraint: You can't specify the C<AvailabilityZone> parameter if the
357 DB instance is a Multi-AZ deployment.
358  
359  
360  
361 =head2 OptionGroupName => Str
362  
363 The name of the option group to be used for the restored DB instance.
364  
365 Permanent options, such as the TDE option for Oracle Advanced Security
366 TDE, can't be removed from an option group, and that option group can't
367 be removed from a DB instance once it is associated with a DB instance
368  
369  
370  
371 =head2 Port => Int
372  
373 The port number on which the database accepts connections.
374  
375 Constraints: Value must be C<1150-65535>
376  
377 Default: The same port as the original DB instance.
378  
379  
380  
381 =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>]
382  
383 The number of CPU cores and the number of threads per core for the DB
384 instance class of the DB instance.
385  
386  
387  
388 =head2 PubliclyAccessible => Bool
389  
390 A value that indicates whether the DB instance is publicly accessible.
391  
392 When the DB instance is publicly accessible, its DNS endpoint resolves
393 to the private IP address from within the DB instance's VPC, and to the
394 public IP address from outside of the DB instance's VPC. Access to the
395 DB instance is ultimately controlled by the security group it uses, and
396 that public access is not permitted if the security group assigned to
397 the DB instance doesn't permit it.
398  
399 When the DB instance isn't publicly accessible, it is an internal DB
400 instance with a DNS name that resolves to a private IP address.
401  
402 For more information, see CreateDBInstance.
403  
404  
405  
406 =head2 RestoreTime => Str
407  
408 The date and time to restore from.
409  
410 Valid Values: Value must be a time in Universal Coordinated Time (UTC)
411 format
412  
413 Constraints:
414  
415 =over
416  
417 =item *
418  
419 Must be before the latest restorable time for the DB instance
420  
421 =item *
422  
423 Can't be specified if the C<UseLatestRestorableTime> parameter is
424 enabled
425  
426 =back
427  
428 Example: C<2009-09-07T23:45:00Z>
429  
430  
431  
432 =head2 SourceDBInstanceAutomatedBackupsArn => Str
433  
434 The Amazon Resource Name (ARN) of the replicated automated backups from
435 which to restore, for example,
436 C<arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE>.
437  
438  
439  
440 =head2 SourceDBInstanceIdentifier => Str
441  
442 The identifier of the source DB instance from which to restore.
443  
444 Constraints:
445  
446 =over
447  
448 =item *
449  
450 Must match the identifier of an existing DB instance.
451  
452 =back
453  
454  
455  
456  
457 =head2 SourceDbiResourceId => Str
458  
459 The resource ID of the source DB instance from which to restore.
460  
461  
462  
463 =head2 StorageType => Str
464  
465 Specifies the storage type to be associated with the DB instance.
466  
467 Valid values: C<standard | gp2 | io1>
468  
469 If you specify C<io1>, you must also include a value for the C<Iops>
470 parameter.
471  
472 Default: C<io1> if the C<Iops> parameter is specified, otherwise C<gp2>
473  
474  
475  
476 =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
477  
478  
479  
480  
481  
482 =head2 B<REQUIRED> TargetDBInstanceIdentifier => Str
483  
484 The name of the new DB instance to be created.
485  
486 Constraints:
487  
488 =over
489  
490 =item *
491  
492 Must contain from 1 to 63 letters, numbers, or hyphens
493  
494 =item *
495  
496 First character must be a letter
497  
498 =item *
499  
500 Can't end with a hyphen or contain two consecutive hyphens
501  
502 =back
503  
504  
505  
506  
507 =head2 TdeCredentialArn => Str
508  
509 The ARN from the key store with which to associate the instance for TDE
510 encryption.
511  
512  
513  
514 =head2 TdeCredentialPassword => Str
515  
516 The password for the given ARN from the key store in order to access
517 the device.
518  
519  
520  
521 =head2 UseDefaultProcessorFeatures => Bool
522  
523 A value that indicates whether the DB instance class of the DB instance
524 uses its default processor features.
525  
526  
527  
528 =head2 UseLatestRestorableTime => Bool
529  
530 A value that indicates whether the DB instance is restored from the
531 latest backup time. By default, the DB instance isn't restored from the
532 latest backup time.
533  
534 Constraints: Can't be specified if the C<RestoreTime> parameter is
535 provided.
536  
537  
538  
539 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
540  
541 A list of EC2 VPC security groups to associate with this DB instance.
542  
543 Default: The default EC2 VPC security group for the DB subnet group's
544 VPC.
545  
546  
547  
548  
549 =head1 SEE ALSO
550  
551 This class forms part of L<Paws>, documenting arguments for method RestoreDBInstanceToPointInTime in L<Paws::RDS>
552  
553 =head1 BUGS and CONTRIBUTIONS
554  
555 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
556  
557 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
558  
559 =cut
560