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

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