blib/lib/Paws/RedShift/RestoreFromClusterSnapshot.pm

filter: Statementstmt 100% 38 / 38 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 40 / 40 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/ResizeProgressMessage.pm ↑ Summary blib/lib/Paws/RedShift/RestoreFromClusterSnapshotResult.pm »
1  
2 package Paws::RedShift::RestoreFromClusterSnapshot;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AdditionalInfo => (is => 'ro', isa => 'Str');
5 1 has AllowVersionUpgrade => (is => 'ro', isa => 'Bool');
6 1 has AquaConfigurationStatus => (is => 'ro', isa => 'Str');
7 1 has AutomatedSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
8 1 has AvailabilityZone => (is => 'ro', isa => 'Str');
9 1 has AvailabilityZoneRelocation => (is => 'ro', isa => 'Bool');
10 1 has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
11 1 has ClusterParameterGroupName => (is => 'ro', isa => 'Str');
12 1 has ClusterSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13 1 has ClusterSubnetGroupName => (is => 'ro', isa => 'Str');
14 1 has ElasticIp => (is => 'ro', isa => 'Str');
15 1 has EnhancedVpcRouting => (is => 'ro', isa => 'Bool');
16 1 has HsmClientCertificateIdentifier => (is => 'ro', isa => 'Str');
17 1 has HsmConfigurationIdentifier => (is => 'ro', isa => 'Str');
18 1 has IamRoles => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
19 1 has KmsKeyId => (is => 'ro', isa => 'Str');
20 1 has MaintenanceTrackName => (is => 'ro', isa => 'Str');
21 1 has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
22 1 has NodeType => (is => 'ro', isa => 'Str');
23 1 has NumberOfNodes => (is => 'ro', isa => 'Int');
24 1 has OwnerAccount => (is => 'ro', isa => 'Str');
25 1 has Port => (is => 'ro', isa => 'Int');
26 1 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
27 1 has PubliclyAccessible => (is => 'ro', isa => 'Bool');
28 1 has SnapshotClusterIdentifier => (is => 'ro', isa => 'Str');
29 1 has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
30 1 has SnapshotScheduleIdentifier => (is => 'ro', isa => 'Str');
31 1 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
32  
33 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
34  
35 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreFromClusterSnapshot');
36 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::RestoreFromClusterSnapshotResult');
37 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreFromClusterSnapshotResult');
38 1 1;
39  
40 ### main pod documentation begin ###
41  
42 =head1 NAME
43  
44 Paws::RedShift::RestoreFromClusterSnapshot - Arguments for method RestoreFromClusterSnapshot on L<Paws::RedShift>
45  
46 =head1 DESCRIPTION
47  
48 This class represents the parameters used for calling the method RestoreFromClusterSnapshot on the
49 L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class
50 as arguments to method RestoreFromClusterSnapshot.
51  
52 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreFromClusterSnapshot.
53  
54 =head1 SYNOPSIS
55  
56 my $redshift = Paws->service('RedShift');
57 my $RestoreFromClusterSnapshotResult =
58 $redshift->RestoreFromClusterSnapshot(
59 ClusterIdentifier => 'MyString',
60 SnapshotIdentifier => 'MyString',
61 AdditionalInfo => 'MyString', # OPTIONAL
62 AllowVersionUpgrade => 1, # OPTIONAL
63 AquaConfigurationStatus => 'enabled', # OPTIONAL
64 AutomatedSnapshotRetentionPeriod => 1, # OPTIONAL
65 AvailabilityZone => 'MyString', # OPTIONAL
66 AvailabilityZoneRelocation => 1, # OPTIONAL
67 ClusterParameterGroupName => 'MyString', # OPTIONAL
68 ClusterSecurityGroups => [
69 'MyString', ... # max: 2147483647
70 ], # OPTIONAL
71 ClusterSubnetGroupName => 'MyString', # OPTIONAL
72 ElasticIp => 'MyString', # OPTIONAL
73 EnhancedVpcRouting => 1, # OPTIONAL
74 HsmClientCertificateIdentifier => 'MyString', # OPTIONAL
75 HsmConfigurationIdentifier => 'MyString', # OPTIONAL
76 IamRoles => [
77 'MyString', ... # max: 2147483647
78 ], # OPTIONAL
79 KmsKeyId => 'MyString', # OPTIONAL
80 MaintenanceTrackName => 'MyString', # OPTIONAL
81 ManualSnapshotRetentionPeriod => 1, # OPTIONAL
82 NodeType => 'MyString', # OPTIONAL
83 NumberOfNodes => 1, # OPTIONAL
84 OwnerAccount => 'MyString', # OPTIONAL
85 Port => 1, # OPTIONAL
86 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
87 PubliclyAccessible => 1, # OPTIONAL
88 SnapshotClusterIdentifier => 'MyString', # OPTIONAL
89 SnapshotScheduleIdentifier => 'MyString', # OPTIONAL
90 VpcSecurityGroupIds => [
91 'MyString', ... # max: 2147483647
92 ], # OPTIONAL
93 );
94  
95 # Results:
96 my $Cluster = $RestoreFromClusterSnapshotResult->Cluster;
97  
98 # Returns a L<Paws::RedShift::RestoreFromClusterSnapshotResult> object.
99  
100 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.
101 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/RestoreFromClusterSnapshot>
102  
103 =head1 ATTRIBUTES
104  
105  
106 =head2 AdditionalInfo => Str
107  
108 Reserved.
109  
110  
111  
112 =head2 AllowVersionUpgrade => Bool
113  
114 If C<true>, major version upgrades can be applied during the
115 maintenance window to the Amazon Redshift engine that is running on the
116 cluster.
117  
118 Default: C<true>
119  
120  
121  
122 =head2 AquaConfigurationStatus => Str
123  
124 The value represents how the cluster is configured to use AQUA
125 (Advanced Query Accelerator) after the cluster is restored. Possible
126 values include the following.
127  
128 =over
129  
130 =item *
131  
132 enabled - Use AQUA if it is available for the current AWS Region and
133 Amazon Redshift node type.
134  
135 =item *
136  
137 disabled - Don't use AQUA.
138  
139 =item *
140  
141 auto - Amazon Redshift determines whether to use AQUA.
142  
143 =back
144  
145  
146 Valid values are: C<"enabled">, C<"disabled">, C<"auto">
147  
148 =head2 AutomatedSnapshotRetentionPeriod => Int
149  
150 The number of days that automated snapshots are retained. If the value
151 is 0, automated snapshots are disabled. Even if automated snapshots are
152 disabled, you can still create manual snapshots when you want with
153 CreateClusterSnapshot.
154  
155 You can't disable automated snapshots for RA3 node types. Set the
156 automated retention period from 1-35 days.
157  
158 Default: The value selected for the cluster from which the snapshot was
159 taken.
160  
161 Constraints: Must be a value from 0 to 35.
162  
163  
164  
165 =head2 AvailabilityZone => Str
166  
167 The Amazon EC2 Availability Zone in which to restore the cluster.
168  
169 Default: A random, system-chosen Availability Zone.
170  
171 Example: C<us-east-2a>
172  
173  
174  
175 =head2 AvailabilityZoneRelocation => Bool
176  
177 The option to enable relocation for an Amazon Redshift cluster between
178 Availability Zones after the cluster is restored.
179  
180  
181  
182 =head2 B<REQUIRED> ClusterIdentifier => Str
183  
184 The identifier of the cluster that will be created from restoring the
185 snapshot.
186  
187 Constraints:
188  
189 =over
190  
191 =item *
192  
193 Must contain from 1 to 63 alphanumeric characters or hyphens.
194  
195 =item *
196  
197 Alphabetic characters must be lowercase.
198  
199 =item *
200  
201 First character must be a letter.
202  
203 =item *
204  
205 Cannot end with a hyphen or contain two consecutive hyphens.
206  
207 =item *
208  
209 Must be unique for all clusters within an AWS account.
210  
211 =back
212  
213  
214  
215  
216 =head2 ClusterParameterGroupName => Str
217  
218 The name of the parameter group to be associated with this cluster.
219  
220 Default: The default Amazon Redshift cluster parameter group. For
221 information about the default parameter group, go to Working with
222 Amazon Redshift Parameter Groups
223 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html).
224  
225 Constraints:
226  
227 =over
228  
229 =item *
230  
231 Must be 1 to 255 alphanumeric characters or hyphens.
232  
233 =item *
234  
235 First character must be a letter.
236  
237 =item *
238  
239 Cannot end with a hyphen or contain two consecutive hyphens.
240  
241 =back
242  
243  
244  
245  
246 =head2 ClusterSecurityGroups => ArrayRef[Str|Undef]
247  
248 A list of security groups to be associated with this cluster.
249  
250 Default: The default cluster security group for Amazon Redshift.
251  
252 Cluster security groups only apply to clusters outside of VPCs.
253  
254  
255  
256 =head2 ClusterSubnetGroupName => Str
257  
258 The name of the subnet group where you want to cluster restored.
259  
260 A snapshot of cluster in VPC can be restored only in VPC. Therefore,
261 you must provide subnet group name where you want the cluster restored.
262  
263  
264  
265 =head2 ElasticIp => Str
266  
267 The elastic IP (EIP) address for the cluster.
268  
269  
270  
271 =head2 EnhancedVpcRouting => Bool
272  
273 An option that specifies whether to create the cluster with enhanced
274 VPC routing enabled. To create a cluster that uses enhanced VPC
275 routing, the cluster must be in a VPC. For more information, see
276 Enhanced VPC Routing
277 (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html)
278 in the Amazon Redshift Cluster Management Guide.
279  
280 If this option is C<true>, enhanced VPC routing is enabled.
281  
282 Default: false
283  
284  
285  
286 =head2 HsmClientCertificateIdentifier => Str
287  
288 Specifies the name of the HSM client certificate the Amazon Redshift
289 cluster uses to retrieve the data encryption keys stored in an HSM.
290  
291  
292  
293 =head2 HsmConfigurationIdentifier => Str
294  
295 Specifies the name of the HSM configuration that contains the
296 information the Amazon Redshift cluster can use to retrieve and store
297 keys in an HSM.
298  
299  
300  
301 =head2 IamRoles => ArrayRef[Str|Undef]
302  
303 A list of AWS Identity and Access Management (IAM) roles that can be
304 used by the cluster to access other AWS services. You must supply the
305 IAM roles in their Amazon Resource Name (ARN) format. You can supply up
306 to 10 IAM roles in a single request.
307  
308 A cluster can have up to 10 IAM roles associated at any time.
309  
310  
311  
312 =head2 KmsKeyId => Str
313  
314 The AWS Key Management Service (KMS) key ID of the encryption key that
315 you want to use to encrypt data in the cluster that you restore from a
316 shared snapshot.
317  
318  
319  
320 =head2 MaintenanceTrackName => Str
321  
322 The name of the maintenance track for the restored cluster. When you
323 take a snapshot, the snapshot inherits the C<MaintenanceTrack> value
324 from the cluster. The snapshot might be on a different track than the
325 cluster that was the source for the snapshot. For example, suppose that
326 you take a snapshot of a cluster that is on the current track and then
327 change the cluster to be on the trailing track. In this case, the
328 snapshot and the source cluster are on different tracks.
329  
330  
331  
332 =head2 ManualSnapshotRetentionPeriod => Int
333  
334 The default number of days to retain a manual snapshot. If the value is
335 -1, the snapshot is retained indefinitely. This setting doesn't change
336 the retention period of existing snapshots.
337  
338 The value must be either -1 or an integer between 1 and 3,653.
339  
340  
341  
342 =head2 NodeType => Str
343  
344 The node type that the restored cluster will be provisioned with.
345  
346 Default: The node type of the cluster from which the snapshot was
347 taken. You can modify this if you are using any DS node type. In that
348 case, you can choose to restore into another DS node type of the same
349 size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or
350 ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must
351 restore into that same instance type and size. In other words, you can
352 only restore a dc1.large instance type into another dc1.large instance
353 type or dc2.large instance type. You can't restore dc1.8xlarge to
354 dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a
355 dc2.8large cluster. For more information about node types, see About
356 Clusters and Nodes
357 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes)
358 in the I<Amazon Redshift Cluster Management Guide>.
359  
360  
361  
362 =head2 NumberOfNodes => Int
363  
364 The number of nodes specified when provisioning the restored cluster.
365  
366  
367  
368 =head2 OwnerAccount => Str
369  
370 The AWS customer account used to create or copy the snapshot. Required
371 if you are restoring a snapshot you do not own, optional if you own the
372 snapshot.
373  
374  
375  
376 =head2 Port => Int
377  
378 The port number on which the cluster accepts connections.
379  
380 Default: The same port as the original cluster.
381  
382 Constraints: Must be between C<1115> and C<65535>.
383  
384  
385  
386 =head2 PreferredMaintenanceWindow => Str
387  
388 The weekly time range (in UTC) during which automated cluster
389 maintenance can occur.
390  
391 Format: C<ddd:hh24:mi-ddd:hh24:mi>
392  
393 Default: The value selected for the cluster from which the snapshot was
394 taken. For more information about the time blocks for each region, see
395 Maintenance Windows
396 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows)
397 in Amazon Redshift Cluster Management Guide.
398  
399 Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
400  
401 Constraints: Minimum 30-minute window.
402  
403  
404  
405 =head2 PubliclyAccessible => Bool
406  
407 If C<true>, the cluster can be accessed from a public network.
408  
409  
410  
411 =head2 SnapshotClusterIdentifier => Str
412  
413 The name of the cluster the source snapshot was created from. This
414 parameter is required if your IAM user has a policy containing a
415 snapshot resource element that specifies anything other than * for the
416 cluster name.
417  
418  
419  
420 =head2 B<REQUIRED> SnapshotIdentifier => Str
421  
422 The name of the snapshot from which to create the new cluster. This
423 parameter isn't case sensitive.
424  
425 Example: C<my-snapshot-id>
426  
427  
428  
429 =head2 SnapshotScheduleIdentifier => Str
430  
431 A unique identifier for the snapshot schedule.
432  
433  
434  
435 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
436  
437 A list of Virtual Private Cloud (VPC) security groups to be associated
438 with the cluster.
439  
440 Default: The default VPC security group is associated with the cluster.
441  
442 VPC security groups only apply to clusters in VPCs.
443  
444  
445  
446  
447 =head1 SEE ALSO
448  
449 This class forms part of L<Paws>, documenting arguments for method RestoreFromClusterSnapshot in L<Paws::RedShift>
450  
451 =head1 BUGS and CONTRIBUTIONS
452  
453 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
454  
455 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
456  
457 =cut
458  
« blib/lib/Paws/RedShift/ResizeProgressMessage.pm ↑ Summary blib/lib/Paws/RedShift/RestoreFromClusterSnapshotResult.pm »