File Coverage

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