File Coverage

blib/lib/Paws/RDS/RestoreDBClusterToPointInTime.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::RestoreDBClusterToPointInTime;
3 1     1   277 use Moose;
  1         3  
  1         6  
4             has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
5             has DBSubnetGroupName => (is => 'ro', isa => 'Str');
6             has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
7             has KmsKeyId => (is => 'ro', isa => 'Str');
8             has OptionGroupName => (is => 'ro', isa => 'Str');
9             has Port => (is => 'ro', isa => 'Int');
10             has RestoreToTime => (is => 'ro', isa => 'Str');
11             has RestoreType => (is => 'ro', isa => 'Str');
12             has SourceDBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
13             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
14             has UseLatestRestorableTime => (is => 'ro', isa => 'Bool');
15             has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16              
17 1     1   5365 use MooseX::ClassAttribute;
  1         3  
  1         7  
18              
19             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTime');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBClusterToPointInTimeResult');
21             class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTimeResult');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::RDS::RestoreDBClusterToPointInTime - Arguments for method RestoreDBClusterToPointInTime on Paws::RDS
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the
33             Amazon Relational Database Service service. Use the attributes of this class
34             as arguments to method RestoreDBClusterToPointInTime.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterToPointInTime.
37              
38             As an example:
39              
40             $service_obj->RestoreDBClusterToPointInTime(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> DBClusterIdentifier => Str
48              
49             The name of the new DB cluster to be created.
50              
51             Constraints:
52              
53             =over
54              
55             =item *
56              
57             Must contain from 1 to 63 alphanumeric characters or hyphens
58              
59             =item *
60              
61             First character must be a letter
62              
63             =item *
64              
65             Cannot end with a hyphen or contain two consecutive hyphens
66              
67             =back
68              
69              
70              
71              
72             =head2 DBSubnetGroupName => Str
73              
74             The DB subnet group name to use for the new DB cluster.
75              
76             Constraints: Must contain no more than 255 alphanumeric characters,
77             periods, underscores, spaces, or hyphens. Must not be default.
78              
79             Example: C<mySubnetgroup>
80              
81              
82              
83             =head2 EnableIAMDatabaseAuthentication => Bool
84              
85             A Boolean value that is true to enable mapping of AWS Identity and
86             Access Management (IAM) accounts to database accounts, and otherwise
87             false.
88              
89             Default: C<false>
90              
91              
92              
93             =head2 KmsKeyId => Str
94              
95             The KMS key identifier to use when restoring an encrypted DB cluster
96             from an encrypted DB cluster.
97              
98             The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
99             encryption key. If you are restoring a DB cluster with the same AWS
100             account that owns the KMS encryption key used to encrypt the new DB
101             cluster, then you can use the KMS key alias instead of the ARN for the
102             KMS encryption key.
103              
104             You can restore to a new DB cluster and encrypt the new DB cluster with
105             a KMS key that is different than the KMS key used to encrypt the source
106             DB cluster. The new DB cluster will be encrypted with the KMS key
107             identified by the C<KmsKeyId> parameter.
108              
109             If you do not specify a value for the C<KmsKeyId> parameter, then the
110             following will occur:
111              
112             =over
113              
114             =item *
115              
116             If the DB cluster is encrypted, then the restored DB cluster is
117             encrypted using the KMS key that was used to encrypt the source DB
118             cluster.
119              
120             =item *
121              
122             If the DB cluster is not encrypted, then the restored DB cluster is not
123             encrypted.
124              
125             =back
126              
127             If C<DBClusterIdentifier> refers to a DB cluster that is not encrypted,
128             then the restore request is rejected.
129              
130              
131              
132             =head2 OptionGroupName => Str
133              
134             The name of the option group for the new DB cluster.
135              
136              
137              
138             =head2 Port => Int
139              
140             The port number on which the new DB cluster accepts connections.
141              
142             Constraints: Value must be C<1150-65535>
143              
144             Default: The same port as the original DB cluster.
145              
146              
147              
148             =head2 RestoreToTime => Str
149              
150             The date and time to restore the DB cluster to.
151              
152             Valid Values: Value must be a time in Universal Coordinated Time (UTC)
153             format
154              
155             Constraints:
156              
157             =over
158              
159             =item *
160              
161             Must be before the latest restorable time for the DB instance
162              
163             =item *
164              
165             Must be specified if C<UseLatestRestorableTime> parameter is not
166             provided
167              
168             =item *
169              
170             Cannot be specified if C<UseLatestRestorableTime> parameter is true
171              
172             =item *
173              
174             Cannot be specified if C<RestoreType> parameter is C<copy-on-write>
175              
176             =back
177              
178             Example: C<2015-03-07T23:45:00Z>
179              
180              
181              
182             =head2 RestoreType => Str
183              
184             The type of restore to be performed. You can specify one of the
185             following values:
186              
187             =over
188              
189             =item *
190              
191             C<full-copy> - The new DB cluster is restored as a full copy of the
192             source DB cluster.
193              
194             =item *
195              
196             C<copy-on-write> - The new DB cluster is restored as a clone of the
197             source DB cluster.
198              
199             =back
200              
201             Constraints: You cannot specify C<copy-on-write> if the engine version
202             of the source DB cluster is earlier than 1.11.
203              
204             If you don't specify a C<RestoreType> value, then the new DB cluster is
205             restored as a full copy of the source DB cluster.
206              
207              
208              
209             =head2 B<REQUIRED> SourceDBClusterIdentifier => Str
210              
211             The identifier of the source DB cluster from which to restore.
212              
213             Constraints:
214              
215             =over
216              
217             =item *
218              
219             Must be the identifier of an existing database instance
220              
221             =item *
222              
223             Must contain from 1 to 63 alphanumeric characters or hyphens
224              
225             =item *
226              
227             First character must be a letter
228              
229             =item *
230              
231             Cannot end with a hyphen or contain two consecutive hyphens
232              
233             =back
234              
235              
236              
237              
238             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
239              
240              
241              
242              
243              
244             =head2 UseLatestRestorableTime => Bool
245              
246             A value that is set to C<true> to restore the DB cluster to the latest
247             restorable backup time, and C<false> otherwise.
248              
249             Default: C<false>
250              
251             Constraints: Cannot be specified if C<RestoreToTime> parameter is
252             provided.
253              
254              
255              
256             =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
257              
258             A list of VPC security groups that the new DB cluster belongs to.
259              
260              
261              
262              
263             =head1 SEE ALSO
264              
265             This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterToPointInTime in L<Paws::RDS>
266              
267             =head1 BUGS and CONTRIBUTIONS
268              
269             The source code is located here: https://github.com/pplu/aws-sdk-perl
270              
271             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
272              
273             =cut
274