blib/lib/Paws/Neptune/RestoreDBClusterFromSnapshot.pm untested

filter: Statementstmt 0.0% 0 / 26 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 28 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Neptune::RestoreDBClusterFromSnapshot;
3 use Moose;
4 has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
6 has DatabaseName => (is => 'ro', isa => 'Str');
7 has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
8 has DBClusterParameterGroupName => (is => 'ro', isa => 'Str');
9 has DBSubnetGroupName => (is => 'ro', isa => 'Str');
10 has DeletionProtection => (is => 'ro', isa => 'Bool');
11 has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
12 has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
13 has Engine => (is => 'ro', isa => 'Str', required => 1);
14 has EngineVersion => (is => 'ro', isa => 'Str');
15 has KmsKeyId => (is => 'ro', isa => 'Str');
16 has OptionGroupName => (is => 'ro', isa => 'Str');
17 has Port => (is => 'ro', isa => 'Int');
18 has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
19 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Tag]');
20 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
21  
22 use MooseX::ClassAttribute;
23  
24 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshot');
25 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::RestoreDBClusterFromSnapshotResult');
26 class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshotResult');
27 1;
28  
29 ### main pod documentation begin ###
30  
31 =head1 NAME
32  
33 Paws::Neptune::RestoreDBClusterFromSnapshot - Arguments for method RestoreDBClusterFromSnapshot on L<Paws::Neptune>
34  
35 =head1 DESCRIPTION
36  
37 This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the
38 L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class
39 as arguments to method RestoreDBClusterFromSnapshot.
40  
41 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromSnapshot.
42  
43 =head1 SYNOPSIS
44  
45 my $rds = Paws->service('Neptune');
46 my $RestoreDBClusterFromSnapshotResult = $rds->RestoreDBClusterFromSnapshot(
47 DBClusterIdentifier => 'MyString',
48 Engine => 'MyString',
49 SnapshotIdentifier => 'MyString',
50 AvailabilityZones => [ 'MyString', ... ], # OPTIONAL
51 CopyTagsToSnapshot => 1, # OPTIONAL
52 DBClusterParameterGroupName => 'MyString', # OPTIONAL
53 DBSubnetGroupName => 'MyString', # OPTIONAL
54 DatabaseName => 'MyString', # OPTIONAL
55 DeletionProtection => 1, # OPTIONAL
56 EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL
57 EnableIAMDatabaseAuthentication => 1, # OPTIONAL
58 EngineVersion => 'MyString', # OPTIONAL
59 KmsKeyId => 'MyString', # OPTIONAL
60 OptionGroupName => 'MyString', # OPTIONAL
61 Port => 1, # OPTIONAL
62 Tags => [
63 {
64 Key => 'MyString',
65 Value => 'MyString',
66 },
67 ...
68 ], # OPTIONAL
69 VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL
70 );
71  
72 # Results:
73 my $DBCluster = $RestoreDBClusterFromSnapshotResult->DBCluster;
74  
75 # Returns a L<Paws::Neptune::RestoreDBClusterFromSnapshotResult> object.
76  
77 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.
78 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterFromSnapshot>
79  
80 =head1 ATTRIBUTES
81  
82  
83 =head2 AvailabilityZones => ArrayRef[Str|Undef]
84  
85 Provides the list of EC2 Availability Zones that instances in the
86 restored DB cluster can be created in.
87  
88  
89  
90 =head2 CopyTagsToSnapshot => Bool
91  
92 I<If set to C<true>, tags are copied to any snapshot of the restored DB
93 cluster that is created.>
94  
95  
96  
97 =head2 DatabaseName => Str
98  
99 Not supported.
100  
101  
102  
103 =head2 B<REQUIRED> DBClusterIdentifier => Str
104  
105 The name of the DB cluster to create from the DB snapshot or DB cluster
106 snapshot. This parameter isn't case-sensitive.
107  
108 Constraints:
109  
110 =over
111  
112 =item *
113  
114 Must contain from 1 to 63 letters, numbers, or hyphens
115  
116 =item *
117  
118 First character must be a letter
119  
120 =item *
121  
122 Cannot end with a hyphen or contain two consecutive hyphens
123  
124 =back
125  
126 Example: C<my-snapshot-id>
127  
128  
129  
130 =head2 DBClusterParameterGroupName => Str
131  
132 The name of the DB cluster parameter group to associate with the new DB
133 cluster.
134  
135 Constraints:
136  
137 =over
138  
139 =item *
140  
141 If supplied, must match the name of an existing
142 DBClusterParameterGroup.
143  
144 =back
145  
146  
147  
148  
149 =head2 DBSubnetGroupName => Str
150  
151 The name of the DB subnet group to use for the new DB cluster.
152  
153 Constraints: If supplied, must match the name of an existing
154 DBSubnetGroup.
155  
156 Example: C<mySubnetgroup>
157  
158  
159  
160 =head2 DeletionProtection => Bool
161  
162 A value that indicates whether the DB cluster has deletion protection
163 enabled. The database can't be deleted when deletion protection is
164 enabled. By default, deletion protection is disabled.
165  
166  
167  
168 =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef]
169  
170 The list of logs that the restored DB cluster is to export to Amazon
171 CloudWatch Logs.
172  
173  
174  
175 =head2 EnableIAMDatabaseAuthentication => Bool
176  
177 True to enable mapping of Amazon Identity and Access Management (IAM)
178 accounts to database accounts, and otherwise false.
179  
180 Default: C<false>
181  
182  
183  
184 =head2 B<REQUIRED> Engine => Str
185  
186 The database engine to use for the new DB cluster.
187  
188 Default: The same as source
189  
190 Constraint: Must be compatible with the engine of the source
191  
192  
193  
194 =head2 EngineVersion => Str
195  
196 The version of the database engine to use for the new DB cluster.
197  
198  
199  
200 =head2 KmsKeyId => Str
201  
202 The Amazon KMS key identifier to use when restoring an encrypted DB
203 cluster from a DB snapshot or DB cluster snapshot.
204  
205 The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
206 encryption key. If you are restoring a DB cluster with the same Amazon
207 account that owns the KMS encryption key used to encrypt the new DB
208 cluster, then you can use the KMS key alias instead of the ARN for the
209 KMS encryption key.
210  
211 If you do not specify a value for the C<KmsKeyId> parameter, then the
212 following will occur:
213  
214 =over
215  
216 =item *
217  
218 If the DB snapshot or DB cluster snapshot in C<SnapshotIdentifier> is
219 encrypted, then the restored DB cluster is encrypted using the KMS key
220 that was used to encrypt the DB snapshot or DB cluster snapshot.
221  
222 =item *
223  
224 If the DB snapshot or DB cluster snapshot in C<SnapshotIdentifier> is
225 not encrypted, then the restored DB cluster is not encrypted.
226  
227 =back
228  
229  
230  
231  
232 =head2 OptionGroupName => Str
233  
234 I<(Not supported by Neptune)>
235  
236  
237  
238 =head2 Port => Int
239  
240 The port number on which the new DB cluster accepts connections.
241  
242 Constraints: Value must be C<1150-65535>
243  
244 Default: The same port as the original DB cluster.
245  
246  
247  
248 =head2 B<REQUIRED> SnapshotIdentifier => Str
249  
250 The identifier for the DB snapshot or DB cluster snapshot to restore
251 from.
252  
253 You can use either the name or the Amazon Resource Name (ARN) to
254 specify a DB cluster snapshot. However, you can use only the ARN to
255 specify a DB snapshot.
256  
257 Constraints:
258  
259 =over
260  
261 =item *
262  
263 Must match the identifier of an existing Snapshot.
264  
265 =back
266  
267  
268  
269  
270 =head2 Tags => ArrayRef[L<Paws::Neptune::Tag>]
271  
272 The tags to be assigned to the restored DB cluster.
273  
274  
275  
276 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
277  
278 A list of VPC security groups that the new DB cluster will belong to.
279  
280  
281  
282  
283 =head1 SEE ALSO
284  
285 This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterFromSnapshot in L<Paws::Neptune>
286  
287 =head1 BUGS and CONTRIBUTIONS
288  
289 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
290  
291 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
292  
293 =cut
294