File Coverage

blib/lib/Paws/RDS/RestoreDBInstanceFromDBSnapshot.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::RestoreDBInstanceFromDBSnapshot;
3 1     1   476 use Moose;
  1         3  
  1         8  
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 DBSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
11             has DBSubnetGroupName => (is => 'ro', isa => 'Str');
12             has Domain => (is => 'ro', isa => 'Str');
13             has DomainIAMRoleName => (is => 'ro', isa => 'Str');
14             has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
15             has Engine => (is => 'ro', isa => 'Str');
16             has Iops => (is => 'ro', isa => 'Int');
17             has LicenseModel => (is => 'ro', isa => 'Str');
18             has MultiAZ => (is => 'ro', isa => 'Bool');
19             has OptionGroupName => (is => 'ro', isa => 'Str');
20             has Port => (is => 'ro', isa => 'Int');
21             has PubliclyAccessible => (is => 'ro', isa => 'Bool');
22             has StorageType => (is => 'ro', isa => 'Str');
23             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
24             has TdeCredentialArn => (is => 'ro', isa => 'Str');
25             has TdeCredentialPassword => (is => 'ro', isa => 'Str');
26              
27 1     1   6071 use MooseX::ClassAttribute;
  1         3  
  1         9  
28              
29             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBInstanceFromDBSnapshot');
30             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBInstanceFromDBSnapshotResult');
31             class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBInstanceFromDBSnapshotResult');
32             1;
33              
34             ### main pod documentation begin ###
35              
36             =head1 NAME
37              
38             Paws::RDS::RestoreDBInstanceFromDBSnapshot - Arguments for method RestoreDBInstanceFromDBSnapshot on Paws::RDS
39              
40             =head1 DESCRIPTION
41              
42             This class represents the parameters used for calling the method RestoreDBInstanceFromDBSnapshot on the
43             Amazon Relational Database Service service. Use the attributes of this class
44             as arguments to method RestoreDBInstanceFromDBSnapshot.
45              
46             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBInstanceFromDBSnapshot.
47              
48             As an example:
49              
50             $service_obj->RestoreDBInstanceFromDBSnapshot(Att1 => $value1, Att2 => $value2, ...);
51              
52             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.
53              
54             =head1 ATTRIBUTES
55              
56              
57             =head2 AutoMinorVersionUpgrade => Bool
58              
59             Indicates that minor version upgrades will be applied automatically to
60             the DB instance during the maintenance window.
61              
62              
63              
64             =head2 AvailabilityZone => Str
65              
66             The EC2 Availability Zone that the database instance will be created
67             in.
68              
69             Default: A random, system-chosen Availability Zone.
70              
71             Constraint: You cannot specify the AvailabilityZone parameter if the
72             MultiAZ parameter is set to C<true>.
73              
74             Example: C<us-east-1a>
75              
76              
77              
78             =head2 CopyTagsToSnapshot => Bool
79              
80             True to copy all tags from the restored DB instance to snapshots of the
81             DB instance; otherwise false. The default is false.
82              
83              
84              
85             =head2 DBInstanceClass => Str
86              
87             The compute and memory capacity of the Amazon RDS DB instance.
88              
89             Valid Values: C<db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
90             | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |
91             db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge
92             | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large |
93             db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge |
94             db.t2.micro | db.t2.small | db.t2.medium | db.t2.large>
95              
96              
97              
98             =head2 B<REQUIRED> DBInstanceIdentifier => Str
99              
100             Name of the DB instance to create from the DB snapshot. This parameter
101             isn't case-sensitive.
102              
103             Constraints:
104              
105             =over
106              
107             =item *
108              
109             Must contain from 1 to 63 alphanumeric characters or hyphens
110              
111             =item *
112              
113             First character must be a letter
114              
115             =item *
116              
117             Cannot end with a hyphen or contain two consecutive hyphens
118              
119             =back
120              
121             Example: C<my-snapshot-id>
122              
123              
124              
125             =head2 DBName => Str
126              
127             The database name for the restored DB instance.
128              
129             This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
130             engines.
131              
132              
133              
134             =head2 B<REQUIRED> DBSnapshotIdentifier => Str
135              
136             The identifier for the DB snapshot to restore from.
137              
138             Constraints:
139              
140             =over
141              
142             =item *
143              
144             Must contain from 1 to 255 alphanumeric characters or hyphens
145              
146             =item *
147              
148             First character must be a letter
149              
150             =item *
151              
152             Cannot end with a hyphen or contain two consecutive hyphens
153              
154             =back
155              
156             If you are restoring from a shared manual DB snapshot, the
157             C<DBSnapshotIdentifier> must be the ARN of the shared DB snapshot.
158              
159              
160              
161             =head2 DBSubnetGroupName => Str
162              
163             The DB subnet group name to use for the new instance.
164              
165             Constraints: Must contain no more than 255 alphanumeric characters,
166             periods, underscores, spaces, or hyphens. Must not be default.
167              
168             Example: C<mySubnetgroup>
169              
170              
171              
172             =head2 Domain => Str
173              
174             Specify the Active Directory Domain to restore the instance in.
175              
176              
177              
178             =head2 DomainIAMRoleName => Str
179              
180             Specify the name of the IAM role to be used when making API calls to
181             the Directory Service.
182              
183              
184              
185             =head2 EnableIAMDatabaseAuthentication => Bool
186              
187             True to enable mapping of AWS Identity and Access Management (IAM)
188             accounts to database accounts; otherwise false.
189              
190             You can enable IAM database authentication for the following database
191             engines
192              
193             =over
194              
195             =item *
196              
197             For MySQL 5.6, minor version 5.6.34 or higher
198              
199             =item *
200              
201             For MySQL 5.7, minor version 5.7.16 or higher
202              
203             =item *
204              
205             Aurora 5.6 or higher.
206              
207             =back
208              
209             Default: C<false>
210              
211              
212              
213             =head2 Engine => Str
214              
215             The database engine to use for the new instance.
216              
217             Default: The same as source
218              
219             Constraint: Must be compatible with the engine of the source. You can
220             restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
221              
222             Valid Values: C<MySQL> | C<mariadb> | C<oracle-se1> | C<oracle-se> |
223             C<oracle-ee> | C<sqlserver-ee> | C<sqlserver-se> | C<sqlserver-ex> |
224             C<sqlserver-web> | C<postgres> | C<aurora>
225              
226              
227              
228             =head2 Iops => Int
229              
230             Specifies the amount of provisioned IOPS for the DB instance, expressed
231             in I/O operations per second. If this parameter is not specified, the
232             IOPS value will be taken from the backup. If this parameter is set to
233             0, the new instance will be converted to a non-PIOPS instance, which
234             will take additional time, though your DB instance will be available
235             for connections before the conversion starts.
236              
237             Constraints: Must be an integer greater than 1000.
238              
239             B<SQL Server>
240              
241             Setting the IOPS value for the SQL Server database engine is not
242             supported.
243              
244              
245              
246             =head2 LicenseModel => Str
247              
248             License model information for the restored DB instance.
249              
250             Default: Same as source.
251              
252             Valid values: C<license-included> | C<bring-your-own-license> |
253             C<general-public-license>
254              
255              
256              
257             =head2 MultiAZ => Bool
258              
259             Specifies if the DB instance is a Multi-AZ deployment.
260              
261             Constraint: You cannot specify the AvailabilityZone parameter if the
262             MultiAZ parameter is set to C<true>.
263              
264              
265              
266             =head2 OptionGroupName => Str
267              
268             The name of the option group to be used for the restored DB instance.
269              
270             Permanent options, such as the TDE option for Oracle Advanced Security
271             TDE, cannot be removed from an option group, and that option group
272             cannot be removed from a DB instance once it is associated with a DB
273             instance
274              
275              
276              
277             =head2 Port => Int
278              
279             The port number on which the database accepts connections.
280              
281             Default: The same port as the original DB instance
282              
283             Constraints: Value must be C<1150-65535>
284              
285              
286              
287             =head2 PubliclyAccessible => Bool
288              
289             Specifies the accessibility options for the DB instance. A value of
290             true specifies an Internet-facing instance with a publicly resolvable
291             DNS name, which resolves to a public IP address. A value of false
292             specifies an internal instance with a DNS name that resolves to a
293             private IP address.
294              
295             Default: The default behavior varies depending on whether a VPC has
296             been requested or not. The following list shows the default behavior in
297             each case.
298              
299             =over
300              
301             =item *
302              
303             B<Default VPC:> true
304              
305             =item *
306              
307             B<VPC:> false
308              
309             =back
310              
311             If no DB subnet group has been specified as part of the request and the
312             PubliclyAccessible value has not been set, the DB instance will be
313             publicly accessible. If a specific DB subnet group has been specified
314             as part of the request and the PubliclyAccessible value has not been
315             set, the DB instance will be private.
316              
317              
318              
319             =head2 StorageType => Str
320              
321             Specifies the storage type to be associated with the DB instance.
322              
323             Valid values: C<standard | gp2 | io1>
324              
325             If you specify C<io1>, you must also include a value for the C<Iops>
326             parameter.
327              
328             Default: C<io1> if the C<Iops> parameter is specified; otherwise
329             C<standard>
330              
331              
332              
333             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
334              
335              
336              
337              
338              
339             =head2 TdeCredentialArn => Str
340              
341             The ARN from the Key Store with which to associate the instance for TDE
342             encryption.
343              
344              
345              
346             =head2 TdeCredentialPassword => Str
347              
348             The password for the given ARN from the Key Store in order to access
349             the device.
350              
351              
352              
353              
354             =head1 SEE ALSO
355              
356             This class forms part of L<Paws>, documenting arguments for method RestoreDBInstanceFromDBSnapshot in L<Paws::RDS>
357              
358             =head1 BUGS and CONTRIBUTIONS
359              
360             The source code is located here: https://github.com/pplu/aws-sdk-perl
361              
362             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
363              
364             =cut
365