File Coverage

blib/lib/Paws/RedShift/CreateCluster.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::CreateCluster;
3 1     1   375 use Moose;
  1     1   4  
  1         6  
  1         551  
  1         3  
  1         7  
4             has AdditionalInfo => (is => 'ro', isa => 'Str');
5             has AllowVersionUpgrade => (is => 'ro', isa => 'Bool');
6             has AutomatedSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
7             has AvailabilityZone => (is => 'ro', isa => 'Str');
8             has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
9             has ClusterParameterGroupName => (is => 'ro', isa => 'Str');
10             has ClusterSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
11             has ClusterSubnetGroupName => (is => 'ro', isa => 'Str');
12             has ClusterType => (is => 'ro', isa => 'Str');
13             has ClusterVersion => (is => 'ro', isa => 'Str');
14             has DBName => (is => 'ro', isa => 'Str');
15             has ElasticIp => (is => 'ro', isa => 'Str');
16             has Encrypted => (is => 'ro', isa => 'Bool');
17             has EnhancedVpcRouting => (is => 'ro', isa => 'Bool');
18             has HsmClientCertificateIdentifier => (is => 'ro', isa => 'Str');
19             has HsmConfigurationIdentifier => (is => 'ro', isa => 'Str');
20             has IamRoles => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
21             has KmsKeyId => (is => 'ro', isa => 'Str');
22             has MasterUsername => (is => 'ro', isa => 'Str', required => 1);
23             has MasterUserPassword => (is => 'ro', isa => 'Str', required => 1);
24             has NodeType => (is => 'ro', isa => 'Str', required => 1);
25             has NumberOfNodes => (is => 'ro', isa => 'Int');
26             has Port => (is => 'ro', isa => 'Int');
27             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
28             has PubliclyAccessible => (is => 'ro', isa => 'Bool');
29             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]');
30             has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
31              
32 1     1   5528 use MooseX::ClassAttribute;
  1     1   2  
  1         9  
  1         6239  
  1         3  
  1         12  
33              
34             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster');
35             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::CreateClusterResult');
36             class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateClusterResult');
37             1;
38              
39             ### main pod documentation begin ###
40              
41             =head1 NAME
42              
43             Paws::RedShift::CreateCluster - Arguments for method CreateCluster on Paws::RedShift
44              
45             =head1 DESCRIPTION
46              
47             This class represents the parameters used for calling the method CreateCluster on the
48             Amazon Redshift service. Use the attributes of this class
49             as arguments to method CreateCluster.
50              
51             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster.
52              
53             As an example:
54              
55             $service_obj->CreateCluster(Att1 => $value1, Att2 => $value2, ...);
56              
57             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.
58              
59             =head1 ATTRIBUTES
60              
61              
62             =head2 AdditionalInfo => Str
63              
64             Reserved.
65              
66              
67              
68             =head2 AllowVersionUpgrade => Bool
69              
70             If C<true>, major version upgrades can be applied during the
71             maintenance window to the Amazon Redshift engine that is running on the
72             cluster.
73              
74             When a new major version of the Amazon Redshift engine is released, you
75             can request that the service automatically apply upgrades during the
76             maintenance window to the Amazon Redshift engine that is running on
77             your cluster.
78              
79             Default: C<true>
80              
81              
82              
83             =head2 AutomatedSnapshotRetentionPeriod => Int
84              
85             The number of days that automated snapshots are retained. If the value
86             is 0, automated snapshots are disabled. Even if automated snapshots are
87             disabled, you can still create manual snapshots when you want with
88             CreateClusterSnapshot.
89              
90             Default: C<1>
91              
92             Constraints: Must be a value from 0 to 35.
93              
94              
95              
96             =head2 AvailabilityZone => Str
97              
98             The EC2 Availability Zone (AZ) in which you want Amazon Redshift to
99             provision the cluster. For example, if you have several EC2 instances
100             running in a specific Availability Zone, then you might want the
101             cluster to be provisioned in the same zone in order to decrease network
102             latency.
103              
104             Default: A random, system-chosen Availability Zone in the region that
105             is specified by the endpoint.
106              
107             Example: C<us-east-1d>
108              
109             Constraint: The specified Availability Zone must be in the same region
110             as the current endpoint.
111              
112              
113              
114             =head2 B<REQUIRED> ClusterIdentifier => Str
115              
116             A unique identifier for the cluster. You use this identifier to refer
117             to the cluster for any subsequent cluster operations such as deleting
118             or modifying. The identifier also appears in the Amazon Redshift
119             console.
120              
121             Constraints:
122              
123             =over
124              
125             =item *
126              
127             Must contain from 1 to 63 alphanumeric characters or hyphens.
128              
129             =item *
130              
131             Alphabetic characters must be lowercase.
132              
133             =item *
134              
135             First character must be a letter.
136              
137             =item *
138              
139             Cannot end with a hyphen or contain two consecutive hyphens.
140              
141             =item *
142              
143             Must be unique for all clusters within an AWS account.
144              
145             =back
146              
147             Example: C<myexamplecluster>
148              
149              
150              
151             =head2 ClusterParameterGroupName => Str
152              
153             The name of the parameter group to be associated with this cluster.
154              
155             Default: The default Amazon Redshift cluster parameter group. For
156             information about the default parameter group, go to Working with
157             Amazon Redshift Parameter Groups
158              
159             Constraints:
160              
161             =over
162              
163             =item *
164              
165             Must be 1 to 255 alphanumeric characters or hyphens.
166              
167             =item *
168              
169             First character must be a letter.
170              
171             =item *
172              
173             Cannot end with a hyphen or contain two consecutive hyphens.
174              
175             =back
176              
177              
178              
179              
180             =head2 ClusterSecurityGroups => ArrayRef[Str|Undef]
181              
182             A list of security groups to be associated with this cluster.
183              
184             Default: The default cluster security group for Amazon Redshift.
185              
186              
187              
188             =head2 ClusterSubnetGroupName => Str
189              
190             The name of a cluster subnet group to be associated with this cluster.
191              
192             If this parameter is not provided the resulting cluster will be
193             deployed outside virtual private cloud (VPC).
194              
195              
196              
197             =head2 ClusterType => Str
198              
199             The type of the cluster. When cluster type is specified as
200              
201             =over
202              
203             =item *
204              
205             C<single-node>, the B<NumberOfNodes> parameter is not required.
206              
207             =item *
208              
209             C<multi-node>, the B<NumberOfNodes> parameter is required.
210              
211             =back
212              
213             Valid Values: C<multi-node> | C<single-node>
214              
215             Default: C<multi-node>
216              
217              
218              
219             =head2 ClusterVersion => Str
220              
221             The version of the Amazon Redshift engine software that you want to
222             deploy on the cluster.
223              
224             The version selected runs on all the nodes in the cluster.
225              
226             Constraints: Only version 1.0 is currently available.
227              
228             Example: C<1.0>
229              
230              
231              
232             =head2 DBName => Str
233              
234             The name of the first database to be created when the cluster is
235             created.
236              
237             To create additional databases after the cluster is created, connect to
238             the cluster with a SQL client and use SQL commands to create a
239             database. For more information, go to Create a Database in the Amazon
240             Redshift Database Developer Guide.
241              
242             Default: C<dev>
243              
244             Constraints:
245              
246             =over
247              
248             =item *
249              
250             Must contain 1 to 64 alphanumeric characters.
251              
252             =item *
253              
254             Must contain only lowercase letters.
255              
256             =item *
257              
258             Cannot be a word that is reserved by the service. A list of reserved
259             words can be found in Reserved Words in the Amazon Redshift Database
260             Developer Guide.
261              
262             =back
263              
264              
265              
266              
267             =head2 ElasticIp => Str
268              
269             The Elastic IP (EIP) address for the cluster.
270              
271             Constraints: The cluster must be provisioned in EC2-VPC and
272             publicly-accessible through an Internet gateway. For more information
273             about provisioning clusters in EC2-VPC, go to Supported Platforms to
274             Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
275              
276              
277              
278             =head2 Encrypted => Bool
279              
280             If C<true>, the data in the cluster is encrypted at rest.
281              
282             Default: false
283              
284              
285              
286             =head2 EnhancedVpcRouting => Bool
287              
288             An option that specifies whether to create the cluster with enhanced
289             VPC routing enabled. To create a cluster that uses enhanced VPC
290             routing, the cluster must be in a VPC. For more information, see
291             Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
292              
293             If this option is C<true>, enhanced VPC routing is enabled.
294              
295             Default: false
296              
297              
298              
299             =head2 HsmClientCertificateIdentifier => Str
300              
301             Specifies the name of the HSM client certificate the Amazon Redshift
302             cluster uses to retrieve the data encryption keys stored in an HSM.
303              
304              
305              
306             =head2 HsmConfigurationIdentifier => Str
307              
308             Specifies the name of the HSM configuration that contains the
309             information the Amazon Redshift cluster can use to retrieve and store
310             keys in an HSM.
311              
312              
313              
314             =head2 IamRoles => ArrayRef[Str|Undef]
315              
316             A list of AWS Identity and Access Management (IAM) roles that can be
317             used by the cluster to access other AWS services. You must supply the
318             IAM roles in their Amazon Resource Name (ARN) format. You can supply up
319             to 10 IAM roles in a single request.
320              
321             A cluster can have up to 10 IAM roles associated with it at any time.
322              
323              
324              
325             =head2 KmsKeyId => Str
326              
327             The AWS Key Management Service (KMS) key ID of the encryption key that
328             you want to use to encrypt data in the cluster.
329              
330              
331              
332             =head2 B<REQUIRED> MasterUsername => Str
333              
334             The user name associated with the master user account for the cluster
335             that is being created.
336              
337             Constraints:
338              
339             =over
340              
341             =item *
342              
343             Must be 1 - 128 alphanumeric characters.
344              
345             =item *
346              
347             First character must be a letter.
348              
349             =item *
350              
351             Cannot be a reserved word. A list of reserved words can be found in
352             Reserved Words in the Amazon Redshift Database Developer Guide.
353              
354             =back
355              
356              
357              
358              
359             =head2 B<REQUIRED> MasterUserPassword => Str
360              
361             The password associated with the master user account for the cluster
362             that is being created.
363              
364             Constraints:
365              
366             =over
367              
368             =item *
369              
370             Must be between 8 and 64 characters in length.
371              
372             =item *
373              
374             Must contain at least one uppercase letter.
375              
376             =item *
377              
378             Must contain at least one lowercase letter.
379              
380             =item *
381              
382             Must contain one number.
383              
384             =item *
385              
386             Can be any printable ASCII character (ASCII code 33 to 126) except '
387             (single quote), " (double quote), \, /, @, or space.
388              
389             =back
390              
391              
392              
393              
394             =head2 B<REQUIRED> NodeType => Str
395              
396             The node type to be provisioned for the cluster. For information about
397             node types, go to Working with Clusters in the I<Amazon Redshift
398             Cluster Management Guide>.
399              
400             Valid Values: C<ds1.xlarge> | C<ds1.8xlarge> | C<ds2.xlarge> |
401             C<ds2.8xlarge> | C<dc1.large> | C<dc1.8xlarge>.
402              
403              
404              
405             =head2 NumberOfNodes => Int
406              
407             The number of compute nodes in the cluster. This parameter is required
408             when the B<ClusterType> parameter is specified as C<multi-node>.
409              
410             For information about determining how many nodes you need, go to
411             Working with Clusters in the I<Amazon Redshift Cluster Management
412             Guide>.
413              
414             If you don't specify this parameter, you get a single-node cluster.
415             When requesting a multi-node cluster, you must specify the number of
416             nodes that you want in the cluster.
417              
418             Default: C<1>
419              
420             Constraints: Value must be at least 1 and no more than 100.
421              
422              
423              
424             =head2 Port => Int
425              
426             The port number on which the cluster accepts incoming connections.
427              
428             The cluster is accessible only via the JDBC and ODBC connection
429             strings. Part of the connection string requires the port on which the
430             cluster will listen for incoming connections.
431              
432             Default: C<5439>
433              
434             Valid Values: C<1150-65535>
435              
436              
437              
438             =head2 PreferredMaintenanceWindow => Str
439              
440             The weekly time range (in UTC) during which automated cluster
441             maintenance can occur.
442              
443             Format: C<ddd:hh24:mi-ddd:hh24:mi>
444              
445             Default: A 30-minute window selected at random from an 8-hour block of
446             time per region, occurring on a random day of the week. For more
447             information about the time blocks for each region, see Maintenance
448             Windows in Amazon Redshift Cluster Management Guide.
449              
450             Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
451              
452             Constraints: Minimum 30-minute window.
453              
454              
455              
456             =head2 PubliclyAccessible => Bool
457              
458             If C<true>, the cluster can be accessed from a public network.
459              
460              
461              
462             =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>]
463              
464             A list of tag instances.
465              
466              
467              
468             =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
469              
470             A list of Virtual Private Cloud (VPC) security groups to be associated
471             with the cluster.
472              
473             Default: The default VPC security group is associated with the cluster.
474              
475              
476              
477              
478             =head1 SEE ALSO
479              
480             This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::RedShift>
481              
482             =head1 BUGS and CONTRIBUTIONS
483              
484             The source code is located here: https://github.com/pplu/aws-sdk-perl
485              
486             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
487              
488             =cut
489