File Coverage

blib/lib/Paws/RedShift/Cluster.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             package Paws::RedShift::Cluster;
2 1     1   444 use Moose;
  1     1   5  
  1         8  
  1         477  
  1         2  
  1         8  
3             has AllowVersionUpgrade => (is => 'ro', isa => 'Bool');
4             has AutomatedSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
5             has AvailabilityZone => (is => 'ro', isa => 'Str');
6             has ClusterCreateTime => (is => 'ro', isa => 'Str');
7             has ClusterIdentifier => (is => 'ro', isa => 'Str');
8             has ClusterNodes => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterNode]');
9             has ClusterParameterGroups => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterParameterGroupStatus]', request_name => 'ClusterParameterGroup', traits => ['NameInRequest']);
10             has ClusterPublicKey => (is => 'ro', isa => 'Str');
11             has ClusterRevisionNumber => (is => 'ro', isa => 'Str');
12             has ClusterSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterSecurityGroupMembership]', request_name => 'ClusterSecurityGroup', traits => ['NameInRequest']);
13             has ClusterSnapshotCopyStatus => (is => 'ro', isa => 'Paws::RedShift::ClusterSnapshotCopyStatus');
14             has ClusterStatus => (is => 'ro', isa => 'Str');
15             has ClusterSubnetGroupName => (is => 'ro', isa => 'Str');
16             has ClusterVersion => (is => 'ro', isa => 'Str');
17             has DBName => (is => 'ro', isa => 'Str');
18             has ElasticIpStatus => (is => 'ro', isa => 'Paws::RedShift::ElasticIpStatus');
19             has Encrypted => (is => 'ro', isa => 'Bool');
20             has Endpoint => (is => 'ro', isa => 'Paws::RedShift::Endpoint');
21             has EnhancedVpcRouting => (is => 'ro', isa => 'Bool');
22             has HsmStatus => (is => 'ro', isa => 'Paws::RedShift::HsmStatus');
23             has IamRoles => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::ClusterIamRole]', request_name => 'ClusterIamRole', traits => ['NameInRequest']);
24             has KmsKeyId => (is => 'ro', isa => 'Str');
25             has MasterUsername => (is => 'ro', isa => 'Str');
26             has ModifyStatus => (is => 'ro', isa => 'Str');
27             has NodeType => (is => 'ro', isa => 'Str');
28             has NumberOfNodes => (is => 'ro', isa => 'Int');
29             has PendingModifiedValues => (is => 'ro', isa => 'Paws::RedShift::PendingModifiedValues');
30             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
31             has PubliclyAccessible => (is => 'ro', isa => 'Bool');
32             has RestoreStatus => (is => 'ro', isa => 'Paws::RedShift::RestoreStatus');
33             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]', request_name => 'Tag', traits => ['NameInRequest']);
34             has VpcId => (is => 'ro', isa => 'Str');
35             has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroup', traits => ['NameInRequest']);
36             1;
37              
38             ### main pod documentation begin ###
39              
40             =head1 NAME
41              
42             Paws::RedShift::Cluster
43              
44             =head1 USAGE
45              
46             This class represents one of two things:
47              
48             =head3 Arguments in a call to a service
49              
50             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
51             Each attribute should be used as a named argument in the calls that expect this type of object.
52              
53             As an example, if Att1 is expected to be a Paws::RedShift::Cluster object:
54              
55             $service_obj->Method(Att1 => { AllowVersionUpgrade => $value, ..., VpcSecurityGroups => $value });
56              
57             =head3 Results returned from an API call
58              
59             Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::Cluster object:
60              
61             $result = $service_obj->Method(...);
62             $result->Att1->AllowVersionUpgrade
63              
64             =head1 DESCRIPTION
65              
66             Describes a cluster.
67              
68             =head1 ATTRIBUTES
69              
70              
71             =head2 AllowVersionUpgrade => Bool
72              
73             A Boolean value that, if C<true>, indicates that major version upgrades
74             will be applied automatically to the cluster during the maintenance
75             window.
76              
77              
78             =head2 AutomatedSnapshotRetentionPeriod => Int
79              
80             The number of days that automatic cluster snapshots are retained.
81              
82              
83             =head2 AvailabilityZone => Str
84              
85             The name of the Availability Zone in which the cluster is located.
86              
87              
88             =head2 ClusterCreateTime => Str
89              
90             The date and time that the cluster was created.
91              
92              
93             =head2 ClusterIdentifier => Str
94              
95             The unique identifier of the cluster.
96              
97              
98             =head2 ClusterNodes => ArrayRef[L<Paws::RedShift::ClusterNode>]
99              
100             The nodes in the cluster.
101              
102              
103             =head2 ClusterParameterGroups => ArrayRef[L<Paws::RedShift::ClusterParameterGroupStatus>]
104              
105             The list of cluster parameter groups that are associated with this
106             cluster. Each parameter group in the list is returned with its status.
107              
108              
109             =head2 ClusterPublicKey => Str
110              
111             The public key for the cluster.
112              
113              
114             =head2 ClusterRevisionNumber => Str
115              
116             The specific revision number of the database in the cluster.
117              
118              
119             =head2 ClusterSecurityGroups => ArrayRef[L<Paws::RedShift::ClusterSecurityGroupMembership>]
120              
121             A list of cluster security group that are associated with the cluster.
122             Each security group is represented by an element that contains
123             C<ClusterSecurityGroup.Name> and C<ClusterSecurityGroup.Status>
124             subelements.
125              
126             Cluster security groups are used when the cluster is not created in an
127             Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC
128             use VPC security groups, which are listed by the B<VpcSecurityGroups>
129             parameter.
130              
131              
132             =head2 ClusterSnapshotCopyStatus => L<Paws::RedShift::ClusterSnapshotCopyStatus>
133              
134             A value that returns the destination region and retention period that
135             are configured for cross-region snapshot copy.
136              
137              
138             =head2 ClusterStatus => Str
139              
140             The current state of the cluster. Possible values are the following:
141              
142             =over
143              
144             =item *
145              
146             C<available>
147              
148             =item *
149              
150             C<creating>
151              
152             =item *
153              
154             C<deleting>
155              
156             =item *
157              
158             C<final-snapshot>
159              
160             =item *
161              
162             C<hardware-failure>
163              
164             =item *
165              
166             C<incompatible-hsm>
167              
168             =item *
169              
170             C<incompatible-network>
171              
172             =item *
173              
174             C<incompatible-parameters>
175              
176             =item *
177              
178             C<incompatible-restore>
179              
180             =item *
181              
182             C<modifying>
183              
184             =item *
185              
186             C<rebooting>
187              
188             =item *
189              
190             C<renaming>
191              
192             =item *
193              
194             C<resizing>
195              
196             =item *
197              
198             C<rotating-keys>
199              
200             =item *
201              
202             C<storage-full>
203              
204             =item *
205              
206             C<updating-hsm>
207              
208             =back
209              
210              
211              
212             =head2 ClusterSubnetGroupName => Str
213              
214             The name of the subnet group that is associated with the cluster. This
215             parameter is valid only when the cluster is in a VPC.
216              
217              
218             =head2 ClusterVersion => Str
219              
220             The version ID of the Amazon Redshift engine that is running on the
221             cluster.
222              
223              
224             =head2 DBName => Str
225              
226             The name of the initial database that was created when the cluster was
227             created. This same name is returned for the life of the cluster. If an
228             initial database was not specified, a database named C<dev>dev was
229             created by default.
230              
231              
232             =head2 ElasticIpStatus => L<Paws::RedShift::ElasticIpStatus>
233              
234             The status of the elastic IP (EIP) address.
235              
236              
237             =head2 Encrypted => Bool
238              
239             A Boolean value that, if C<true>, indicates that data in the cluster is
240             encrypted at rest.
241              
242              
243             =head2 Endpoint => L<Paws::RedShift::Endpoint>
244              
245             The connection endpoint.
246              
247              
248             =head2 EnhancedVpcRouting => Bool
249              
250             An option that specifies whether to create the cluster with enhanced
251             VPC routing enabled. To create a cluster that uses enhanced VPC
252             routing, the cluster must be in a VPC. For more information, see
253             Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
254              
255             If this option is C<true>, enhanced VPC routing is enabled.
256              
257             Default: false
258              
259              
260             =head2 HsmStatus => L<Paws::RedShift::HsmStatus>
261              
262             A value that reports whether the Amazon Redshift cluster has finished
263             applying any hardware security module (HSM) settings changes specified
264             in a modify cluster command.
265              
266             Values: active, applying
267              
268              
269             =head2 IamRoles => ArrayRef[L<Paws::RedShift::ClusterIamRole>]
270              
271             A list of AWS Identity and Access Management (IAM) roles that can be
272             used by the cluster to access other AWS services.
273              
274              
275             =head2 KmsKeyId => Str
276              
277             The AWS Key Management Service (AWS KMS) key ID of the encryption key
278             used to encrypt data in the cluster.
279              
280              
281             =head2 MasterUsername => Str
282              
283             The master user name for the cluster. This name is used to connect to
284             the database that is specified in the B<DBName> parameter.
285              
286              
287             =head2 ModifyStatus => Str
288              
289             The status of a modify operation, if any, initiated for the cluster.
290              
291              
292             =head2 NodeType => Str
293              
294             The node type for the nodes in the cluster.
295              
296              
297             =head2 NumberOfNodes => Int
298              
299             The number of compute nodes in the cluster.
300              
301              
302             =head2 PendingModifiedValues => L<Paws::RedShift::PendingModifiedValues>
303              
304             A value that, if present, indicates that changes to the cluster are
305             pending. Specific pending changes are identified by subelements.
306              
307              
308             =head2 PreferredMaintenanceWindow => Str
309              
310             The weekly time range, in Universal Coordinated Time (UTC), during
311             which system maintenance can occur.
312              
313              
314             =head2 PubliclyAccessible => Bool
315              
316             A Boolean value that, if C<true>, indicates that the cluster can be
317             accessed from a public network.
318              
319              
320             =head2 RestoreStatus => L<Paws::RedShift::RestoreStatus>
321              
322             A value that describes the status of a cluster restore action. This
323             parameter returns null if the cluster was not created by restoring a
324             snapshot.
325              
326              
327             =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>]
328              
329             The list of tags for the cluster.
330              
331              
332             =head2 VpcId => Str
333              
334             The identifier of the VPC the cluster is in, if the cluster is in a
335             VPC.
336              
337              
338             =head2 VpcSecurityGroups => ArrayRef[L<Paws::RedShift::VpcSecurityGroupMembership>]
339              
340             A list of Amazon Virtual Private Cloud (Amazon VPC) security groups
341             that are associated with the cluster. This parameter is returned only
342             if the cluster is in a VPC.
343              
344              
345              
346             =head1 SEE ALSO
347              
348             This class forms part of L<Paws>, describing an object used in L<Paws::RedShift>
349              
350             =head1 BUGS and CONTRIBUTIONS
351              
352             The source code is located here: https://github.com/pplu/aws-sdk-perl
353              
354             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
355              
356             =cut
357