blib/lib/Paws/RedShift/Cluster.pm

filter: Statementstmt 100% 54 / 54 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 55 / 55 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/AvailabilityZone.pm ↑ Summary blib/lib/Paws/RedShift/ClusterIamRole.pm »
1 # Generated by default/object.tt
2 package Paws::RedShift::Cluster;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AllowVersionUpgrade => (is => 'ro', isa => 'Bool');
5 1 has AquaConfiguration => (is => 'ro', isa => 'Paws::RedShift::AquaConfiguration');
6 1 has AutomatedSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
7 1 has AvailabilityZone => (is => 'ro', isa => 'Str');
8 1 has AvailabilityZoneRelocationStatus => (is => 'ro', isa => 'Str');
9 1 has ClusterAvailabilityStatus => (is => 'ro', isa => 'Str');
10 1 has ClusterCreateTime => (is => 'ro', isa => 'Str');
11 1 has ClusterIdentifier => (is => 'ro', isa => 'Str');
12 1 has ClusterNamespaceArn => (is => 'ro', isa => 'Str');
13 1 has ClusterNodes => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterNode]');
14 1 has ClusterParameterGroups => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterParameterGroupStatus]', request_name => 'ClusterParameterGroup', traits => ['NameInRequest']);
15 1 has ClusterPublicKey => (is => 'ro', isa => 'Str');
16 1 has ClusterRevisionNumber => (is => 'ro', isa => 'Str');
17 1 has ClusterSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterSecurityGroupMembership]', request_name => 'ClusterSecurityGroup', traits => ['NameInRequest']);
18 1 has ClusterSnapshotCopyStatus => (is => 'ro', isa => 'Paws::RedShift::ClusterSnapshotCopyStatus');
19 1 has ClusterStatus => (is => 'ro', isa => 'Str');
20 1 has ClusterSubnetGroupName => (is => 'ro', isa => 'Str');
21 1 has ClusterVersion => (is => 'ro', isa => 'Str');
22 1 has DataTransferProgress => (is => 'ro', isa => 'Paws::RedShift::DataTransferProgress');
23 1 has DBName => (is => 'ro', isa => 'Str');
24 1 has DeferredMaintenanceWindows => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::DeferredMaintenanceWindow]', request_name => 'DeferredMaintenanceWindow', traits => ['NameInRequest']);
25 1 has ElasticIpStatus => (is => 'ro', isa => 'Paws::RedShift::ElasticIpStatus');
26 1 has ElasticResizeNumberOfNodeOptions => (is => 'ro', isa => 'Str');
27 1 has Encrypted => (is => 'ro', isa => 'Bool');
28 1 has Endpoint => (is => 'ro', isa => 'Paws::RedShift::Endpoint');
29 1 has EnhancedVpcRouting => (is => 'ro', isa => 'Bool');
30 1 has ExpectedNextSnapshotScheduleTime => (is => 'ro', isa => 'Str');
31 1 has ExpectedNextSnapshotScheduleTimeStatus => (is => 'ro', isa => 'Str');
32 1 has HsmStatus => (is => 'ro', isa => 'Paws::RedShift::HsmStatus');
33 1 has IamRoles => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterIamRole]', request_name => 'ClusterIamRole', traits => ['NameInRequest']);
34 1 has KmsKeyId => (is => 'ro', isa => 'Str');
35 1 has MaintenanceTrackName => (is => 'ro', isa => 'Str');
36 1 has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
37 1 has MasterUsername => (is => 'ro', isa => 'Str');
38 1 has ModifyStatus => (is => 'ro', isa => 'Str');
39 1 has NextMaintenanceWindowStartTime => (is => 'ro', isa => 'Str');
40 1 has NodeType => (is => 'ro', isa => 'Str');
41 1 has NumberOfNodes => (is => 'ro', isa => 'Int');
42 1 has PendingActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
43 1 has PendingModifiedValues => (is => 'ro', isa => 'Paws::RedShift::PendingModifiedValues');
44 1 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
45 1 has PubliclyAccessible => (is => 'ro', isa => 'Bool');
46 1 has ResizeInfo => (is => 'ro', isa => 'Paws::RedShift::ResizeInfo');
47 1 has RestoreStatus => (is => 'ro', isa => 'Paws::RedShift::RestoreStatus');
48 1 has SnapshotScheduleIdentifier => (is => 'ro', isa => 'Str');
49 1 has SnapshotScheduleState => (is => 'ro', isa => 'Str');
50 1 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]', request_name => 'Tag', traits => ['NameInRequest']);
51 1 has TotalStorageCapacityInMegaBytes => (is => 'ro', isa => 'Int');
52 1 has VpcId => (is => 'ro', isa => 'Str');
53 1 has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroup', traits => ['NameInRequest']);
54  
55 1 1;
56  
57 ### main pod documentation begin ###
58  
59 =head1 NAME
60  
61 Paws::RedShift::Cluster
62  
63 =head1 USAGE
64  
65 This class represents one of two things:
66  
67 =head3 Arguments in a call to a service
68  
69 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
70 Each attribute should be used as a named argument in the calls that expect this type of object.
71  
72 As an example, if Att1 is expected to be a Paws::RedShift::Cluster object:
73  
74 $service_obj->Method(Att1 => { AllowVersionUpgrade => $value, ..., VpcSecurityGroups => $value });
75  
76 =head3 Results returned from an API call
77  
78 Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::Cluster object:
79  
80 $result = $service_obj->Method(...);
81 $result->Att1->AllowVersionUpgrade
82  
83 =head1 DESCRIPTION
84  
85 Describes a cluster.
86  
87 =head1 ATTRIBUTES
88  
89  
90 =head2 AllowVersionUpgrade => Bool
91  
92 A boolean value that, if C<true>, indicates that major version upgrades
93 will be applied automatically to the cluster during the maintenance
94 window.
95  
96  
97 =head2 AquaConfiguration => L<Paws::RedShift::AquaConfiguration>
98  
99 The AQUA (Advanced Query Accelerator) configuration of the cluster.
100  
101  
102 =head2 AutomatedSnapshotRetentionPeriod => Int
103  
104 The number of days that automatic cluster snapshots are retained.
105  
106  
107 =head2 AvailabilityZone => Str
108  
109 The name of the Availability Zone in which the cluster is located.
110  
111  
112 =head2 AvailabilityZoneRelocationStatus => Str
113  
114 Describes the status of the Availability Zone relocation operation.
115  
116  
117 =head2 ClusterAvailabilityStatus => Str
118  
119 The availability status of the cluster for queries. Possible values are
120 the following:
121  
122 =over
123  
124 =item *
125  
126 Available - The cluster is available for queries.
127  
128 =item *
129  
130 Unavailable - The cluster is not available for queries.
131  
132 =item *
133  
134 Maintenance - The cluster is intermittently available for queries due
135 to maintenance activities.
136  
137 =item *
138  
139 Modifying - The cluster is intermittently available for queries due to
140 changes that modify the cluster.
141  
142 =item *
143  
144 Failed - The cluster failed and is not available for queries.
145  
146 =back
147  
148  
149  
150 =head2 ClusterCreateTime => Str
151  
152 The date and time that the cluster was created.
153  
154  
155 =head2 ClusterIdentifier => Str
156  
157 The unique identifier of the cluster.
158  
159  
160 =head2 ClusterNamespaceArn => Str
161  
162 The namespace Amazon Resource Name (ARN) of the cluster.
163  
164  
165 =head2 ClusterNodes => ArrayRef[L<Paws::RedShift::ClusterNode>]
166  
167 The nodes in the cluster.
168  
169  
170 =head2 ClusterParameterGroups => ArrayRef[L<Paws::RedShift::ClusterParameterGroupStatus>]
171  
172 The list of cluster parameter groups that are associated with this
173 cluster. Each parameter group in the list is returned with its status.
174  
175  
176 =head2 ClusterPublicKey => Str
177  
178 The public key for the cluster.
179  
180  
181 =head2 ClusterRevisionNumber => Str
182  
183 The specific revision number of the database in the cluster.
184  
185  
186 =head2 ClusterSecurityGroups => ArrayRef[L<Paws::RedShift::ClusterSecurityGroupMembership>]
187  
188 A list of cluster security group that are associated with the cluster.
189 Each security group is represented by an element that contains
190 C<ClusterSecurityGroup.Name> and C<ClusterSecurityGroup.Status>
191 subelements.
192  
193 Cluster security groups are used when the cluster is not created in an
194 Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC
195 use VPC security groups, which are listed by the B<VpcSecurityGroups>
196 parameter.
197  
198  
199 =head2 ClusterSnapshotCopyStatus => L<Paws::RedShift::ClusterSnapshotCopyStatus>
200  
201 A value that returns the destination region and retention period that
202 are configured for cross-region snapshot copy.
203  
204  
205 =head2 ClusterStatus => Str
206  
207 The current state of the cluster. Possible values are the following:
208  
209 =over
210  
211 =item *
212  
213 C<available>
214  
215 =item *
216  
217 C<available, prep-for-resize>
218  
219 =item *
220  
221 C<available, resize-cleanup>
222  
223 =item *
224  
225 C<cancelling-resize>
226  
227 =item *
228  
229 C<creating>
230  
231 =item *
232  
233 C<deleting>
234  
235 =item *
236  
237 C<final-snapshot>
238  
239 =item *
240  
241 C<hardware-failure>
242  
243 =item *
244  
245 C<incompatible-hsm>
246  
247 =item *
248  
249 C<incompatible-network>
250  
251 =item *
252  
253 C<incompatible-parameters>
254  
255 =item *
256  
257 C<incompatible-restore>
258  
259 =item *
260  
261 C<modifying>
262  
263 =item *
264  
265 C<paused>
266  
267 =item *
268  
269 C<rebooting>
270  
271 =item *
272  
273 C<renaming>
274  
275 =item *
276  
277 C<resizing>
278  
279 =item *
280  
281 C<rotating-keys>
282  
283 =item *
284  
285 C<storage-full>
286  
287 =item *
288  
289 C<updating-hsm>
290  
291 =back
292  
293  
294  
295 =head2 ClusterSubnetGroupName => Str
296  
297 The name of the subnet group that is associated with the cluster. This
298 parameter is valid only when the cluster is in a VPC.
299  
300  
301 =head2 ClusterVersion => Str
302  
303 The version ID of the Amazon Redshift engine that is running on the
304 cluster.
305  
306  
307 =head2 DataTransferProgress => L<Paws::RedShift::DataTransferProgress>
308  
309  
310  
311  
312 =head2 DBName => Str
313  
314 The name of the initial database that was created when the cluster was
315 created. This same name is returned for the life of the cluster. If an
316 initial database was not specified, a database named C<dev>dev was
317 created by default.
318  
319  
320 =head2 DeferredMaintenanceWindows => ArrayRef[L<Paws::RedShift::DeferredMaintenanceWindow>]
321  
322 Describes a group of C<DeferredMaintenanceWindow> objects.
323  
324  
325 =head2 ElasticIpStatus => L<Paws::RedShift::ElasticIpStatus>
326  
327 The status of the elastic IP (EIP) address.
328  
329  
330 =head2 ElasticResizeNumberOfNodeOptions => Str
331  
332 The number of nodes that you can resize the cluster to with the elastic
333 resize method.
334  
335  
336 =head2 Encrypted => Bool
337  
338 A boolean value that, if C<true>, indicates that data in the cluster is
339 encrypted at rest.
340  
341  
342 =head2 Endpoint => L<Paws::RedShift::Endpoint>
343  
344 The connection endpoint.
345  
346  
347 =head2 EnhancedVpcRouting => Bool
348  
349 An option that specifies whether to create the cluster with enhanced
350 VPC routing enabled. To create a cluster that uses enhanced VPC
351 routing, the cluster must be in a VPC. For more information, see
352 Enhanced VPC Routing
353 (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html)
354 in the Amazon Redshift Cluster Management Guide.
355  
356 If this option is C<true>, enhanced VPC routing is enabled.
357  
358 Default: false
359  
360  
361 =head2 ExpectedNextSnapshotScheduleTime => Str
362  
363 The date and time when the next snapshot is expected to be taken for
364 clusters with a valid snapshot schedule and backups enabled.
365  
366  
367 =head2 ExpectedNextSnapshotScheduleTimeStatus => Str
368  
369 The status of next expected snapshot for clusters having a valid
370 snapshot schedule and backups enabled. Possible values are the
371 following:
372  
373 =over
374  
375 =item *
376  
377 OnTrack - The next snapshot is expected to be taken on time.
378  
379 =item *
380  
381 Pending - The next snapshot is pending to be taken.
382  
383 =back
384  
385  
386  
387 =head2 HsmStatus => L<Paws::RedShift::HsmStatus>
388  
389 A value that reports whether the Amazon Redshift cluster has finished
390 applying any hardware security module (HSM) settings changes specified
391 in a modify cluster command.
392  
393 Values: active, applying
394  
395  
396 =head2 IamRoles => ArrayRef[L<Paws::RedShift::ClusterIamRole>]
397  
398 A list of AWS Identity and Access Management (IAM) roles that can be
399 used by the cluster to access other AWS services.
400  
401  
402 =head2 KmsKeyId => Str
403  
404 The AWS Key Management Service (AWS KMS) key ID of the encryption key
405 used to encrypt data in the cluster.
406  
407  
408 =head2 MaintenanceTrackName => Str
409  
410 The name of the maintenance track for the cluster.
411  
412  
413 =head2 ManualSnapshotRetentionPeriod => Int
414  
415 The default number of days to retain a manual snapshot. If the value is
416 -1, the snapshot is retained indefinitely. This setting doesn't change
417 the retention period of existing snapshots.
418  
419 The value must be either -1 or an integer between 1 and 3,653.
420  
421  
422 =head2 MasterUsername => Str
423  
424 The master user name for the cluster. This name is used to connect to
425 the database that is specified in the B<DBName> parameter.
426  
427  
428 =head2 ModifyStatus => Str
429  
430 The status of a modify operation, if any, initiated for the cluster.
431  
432  
433 =head2 NextMaintenanceWindowStartTime => Str
434  
435 The date and time in UTC when system maintenance can begin.
436  
437  
438 =head2 NodeType => Str
439  
440 The node type for the nodes in the cluster.
441  
442  
443 =head2 NumberOfNodes => Int
444  
445 The number of compute nodes in the cluster.
446  
447  
448 =head2 PendingActions => ArrayRef[Str|Undef]
449  
450 Cluster operations that are waiting to be started.
451  
452  
453 =head2 PendingModifiedValues => L<Paws::RedShift::PendingModifiedValues>
454  
455 A value that, if present, indicates that changes to the cluster are
456 pending. Specific pending changes are identified by subelements.
457  
458  
459 =head2 PreferredMaintenanceWindow => Str
460  
461 The weekly time range, in Universal Coordinated Time (UTC), during
462 which system maintenance can occur.
463  
464  
465 =head2 PubliclyAccessible => Bool
466  
467 A boolean value that, if C<true>, indicates that the cluster can be
468 accessed from a public network.
469  
470  
471 =head2 ResizeInfo => L<Paws::RedShift::ResizeInfo>
472  
473 Returns the following:
474  
475 =over
476  
477 =item *
478  
479 AllowCancelResize: a boolean value indicating if the resize operation
480 can be cancelled.
481  
482 =item *
483  
484 ResizeType: Returns ClassicResize
485  
486 =back
487  
488  
489  
490 =head2 RestoreStatus => L<Paws::RedShift::RestoreStatus>
491  
492 A value that describes the status of a cluster restore action. This
493 parameter returns null if the cluster was not created by restoring a
494 snapshot.
495  
496  
497 =head2 SnapshotScheduleIdentifier => Str
498  
499 A unique identifier for the cluster snapshot schedule.
500  
501  
502 =head2 SnapshotScheduleState => Str
503  
504 The current state of the cluster snapshot schedule.
505  
506  
507 =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>]
508  
509 The list of tags for the cluster.
510  
511  
512 =head2 TotalStorageCapacityInMegaBytes => Int
513  
514 The total storage capacity of the cluster in megabytes.
515  
516  
517 =head2 VpcId => Str
518  
519 The identifier of the VPC the cluster is in, if the cluster is in a
520 VPC.
521  
522  
523 =head2 VpcSecurityGroups => ArrayRef[L<Paws::RedShift::VpcSecurityGroupMembership>]
524  
525 A list of Amazon Virtual Private Cloud (Amazon VPC) security groups
526 that are associated with the cluster. This parameter is returned only
527 if the cluster is in a VPC.
528  
529  
530  
531 =head1 SEE ALSO
532  
533 This class forms part of L<Paws>, describing an object used in L<Paws::RedShift>
534  
535 =head1 BUGS and CONTRIBUTIONS
536  
537 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
538  
539 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
540  
541 =cut
542  
« blib/lib/Paws/RedShift/AvailabilityZone.pm ↑ Summary blib/lib/Paws/RedShift/ClusterIamRole.pm »