blib/lib/Paws/RedShift/CreateCluster.pm

filter: Statementstmt 100% 42 / 42 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 44 / 44 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/CopyClusterSnapshotResult.pm ↑ Summary blib/lib/Paws/RedShift/CreateClusterParameterGroup.pm »
1  
2 package Paws::RedShift::CreateCluster;
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 ClusterType => (is => 'ro', isa => 'Str');
15 1 has ClusterVersion => (is => 'ro', isa => 'Str');
16 1 has DBName => (is => 'ro', isa => 'Str');
17 1 has ElasticIp => (is => 'ro', isa => 'Str');
18 1 has Encrypted => (is => 'ro', isa => 'Bool');
19 1 has EnhancedVpcRouting => (is => 'ro', isa => 'Bool');
20 1 has HsmClientCertificateIdentifier => (is => 'ro', isa => 'Str');
21 1 has HsmConfigurationIdentifier => (is => 'ro', isa => 'Str');
22 1 has IamRoles => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
23 1 has KmsKeyId => (is => 'ro', isa => 'Str');
24 1 has MaintenanceTrackName => (is => 'ro', isa => 'Str');
25 1 has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int');
26 1 has MasterUsername => (is => 'ro', isa => 'Str', required => 1);
27 1 has MasterUserPassword => (is => 'ro', isa => 'Str', required => 1);
28 1 has NodeType => (is => 'ro', isa => 'Str', required => 1);
29 1 has NumberOfNodes => (is => 'ro', isa => 'Int');
30 1 has Port => (is => 'ro', isa => 'Int');
31 1 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
32 1 has PubliclyAccessible => (is => 'ro', isa => 'Bool');
33 1 has SnapshotScheduleIdentifier => (is => 'ro', isa => 'Str');
34 1 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]');
35 1 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
36  
37 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
38  
39 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster');
40 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::CreateClusterResult');
41 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateClusterResult');
42 1 1;
43  
44 ### main pod documentation begin ###
45  
46 =head1 NAME
47  
48 Paws::RedShift::CreateCluster - Arguments for method CreateCluster on L<Paws::RedShift>
49  
50 =head1 DESCRIPTION
51  
52 This class represents the parameters used for calling the method CreateCluster on the
53 L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class
54 as arguments to method CreateCluster.
55  
56 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster.
57  
58 =head1 SYNOPSIS
59  
60 my $redshift = Paws->service('RedShift');
61 my $CreateClusterResult = $redshift->CreateCluster(
62 ClusterIdentifier => 'MyString',
63 MasterUserPassword => 'MyString',
64 MasterUsername => 'MyString',
65 NodeType => 'MyString',
66 AdditionalInfo => 'MyString', # OPTIONAL
67 AllowVersionUpgrade => 1, # OPTIONAL
68 AquaConfigurationStatus => 'enabled', # OPTIONAL
69 AutomatedSnapshotRetentionPeriod => 1, # OPTIONAL
70 AvailabilityZone => 'MyString', # OPTIONAL
71 AvailabilityZoneRelocation => 1, # OPTIONAL
72 ClusterParameterGroupName => 'MyString', # OPTIONAL
73 ClusterSecurityGroups => [
74 'MyString', ... # max: 2147483647
75 ], # OPTIONAL
76 ClusterSubnetGroupName => 'MyString', # OPTIONAL
77 ClusterType => 'MyString', # OPTIONAL
78 ClusterVersion => 'MyString', # OPTIONAL
79 DBName => 'MyString', # OPTIONAL
80 ElasticIp => 'MyString', # OPTIONAL
81 Encrypted => 1, # OPTIONAL
82 EnhancedVpcRouting => 1, # OPTIONAL
83 HsmClientCertificateIdentifier => 'MyString', # OPTIONAL
84 HsmConfigurationIdentifier => 'MyString', # OPTIONAL
85 IamRoles => [
86 'MyString', ... # max: 2147483647
87 ], # OPTIONAL
88 KmsKeyId => 'MyString', # OPTIONAL
89 MaintenanceTrackName => 'MyString', # OPTIONAL
90 ManualSnapshotRetentionPeriod => 1, # OPTIONAL
91 NumberOfNodes => 1, # OPTIONAL
92 Port => 1, # OPTIONAL
93 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
94 PubliclyAccessible => 1, # OPTIONAL
95 SnapshotScheduleIdentifier => 'MyString', # OPTIONAL
96 Tags => [
97 {
98 Key => 'MyString', # max: 2147483647
99 Value => 'MyString', # max: 2147483647
100 },
101 ...
102 ], # OPTIONAL
103 VpcSecurityGroupIds => [
104 'MyString', ... # max: 2147483647
105 ], # OPTIONAL
106 );
107  
108 # Results:
109 my $Cluster = $CreateClusterResult->Cluster;
110  
111 # Returns a L<Paws::RedShift::CreateClusterResult> object.
112  
113 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.
114 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/CreateCluster>
115  
116 =head1 ATTRIBUTES
117  
118  
119 =head2 AdditionalInfo => Str
120  
121 Reserved.
122  
123  
124  
125 =head2 AllowVersionUpgrade => Bool
126  
127 If C<true>, major version upgrades can be applied during the
128 maintenance window to the Amazon Redshift engine that is running on the
129 cluster.
130  
131 When a new major version of the Amazon Redshift engine is released, you
132 can request that the service automatically apply upgrades during the
133 maintenance window to the Amazon Redshift engine that is running on
134 your cluster.
135  
136 Default: C<true>
137  
138  
139  
140 =head2 AquaConfigurationStatus => Str
141  
142 The value represents how the cluster is configured to use AQUA
143 (Advanced Query Accelerator) when it is created. Possible values
144 include the following.
145  
146 =over
147  
148 =item *
149  
150 enabled - Use AQUA if it is available for the current AWS Region and
151 Amazon Redshift node type.
152  
153 =item *
154  
155 disabled - Don't use AQUA.
156  
157 =item *
158  
159 auto - Amazon Redshift determines whether to use AQUA.
160  
161 =back
162  
163  
164 Valid values are: C<"enabled">, C<"disabled">, C<"auto">
165  
166 =head2 AutomatedSnapshotRetentionPeriod => Int
167  
168 The number of days that automated snapshots are retained. If the value
169 is 0, automated snapshots are disabled. Even if automated snapshots are
170 disabled, you can still create manual snapshots when you want with
171 CreateClusterSnapshot.
172  
173 You can't disable automated snapshots for RA3 node types. Set the
174 automated retention period from 1-35 days.
175  
176 Default: C<1>
177  
178 Constraints: Must be a value from 0 to 35.
179  
180  
181  
182 =head2 AvailabilityZone => Str
183  
184 The EC2 Availability Zone (AZ) in which you want Amazon Redshift to
185 provision the cluster. For example, if you have several EC2 instances
186 running in a specific Availability Zone, then you might want the
187 cluster to be provisioned in the same zone in order to decrease network
188 latency.
189  
190 Default: A random, system-chosen Availability Zone in the region that
191 is specified by the endpoint.
192  
193 Example: C<us-east-2d>
194  
195 Constraint: The specified Availability Zone must be in the same region
196 as the current endpoint.
197  
198  
199  
200 =head2 AvailabilityZoneRelocation => Bool
201  
202 The option to enable relocation for an Amazon Redshift cluster between
203 Availability Zones after the cluster is created.
204  
205  
206  
207 =head2 B<REQUIRED> ClusterIdentifier => Str
208  
209 A unique identifier for the cluster. You use this identifier to refer
210 to the cluster for any subsequent cluster operations such as deleting
211 or modifying. The identifier also appears in the Amazon Redshift
212 console.
213  
214 Constraints:
215  
216 =over
217  
218 =item *
219  
220 Must contain from 1 to 63 alphanumeric characters or hyphens.
221  
222 =item *
223  
224 Alphabetic characters must be lowercase.
225  
226 =item *
227  
228 First character must be a letter.
229  
230 =item *
231  
232 Cannot end with a hyphen or contain two consecutive hyphens.
233  
234 =item *
235  
236 Must be unique for all clusters within an AWS account.
237  
238 =back
239  
240 Example: C<myexamplecluster>
241  
242  
243  
244 =head2 ClusterParameterGroupName => Str
245  
246 The name of the parameter group to be associated with this cluster.
247  
248 Default: The default Amazon Redshift cluster parameter group. For
249 information about the default parameter group, go to Working with
250 Amazon Redshift Parameter Groups
251 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)
252  
253 Constraints:
254  
255 =over
256  
257 =item *
258  
259 Must be 1 to 255 alphanumeric characters or hyphens.
260  
261 =item *
262  
263 First character must be a letter.
264  
265 =item *
266  
267 Cannot end with a hyphen or contain two consecutive hyphens.
268  
269 =back
270  
271  
272  
273  
274 =head2 ClusterSecurityGroups => ArrayRef[Str|Undef]
275  
276 A list of security groups to be associated with this cluster.
277  
278 Default: The default cluster security group for Amazon Redshift.
279  
280  
281  
282 =head2 ClusterSubnetGroupName => Str
283  
284 The name of a cluster subnet group to be associated with this cluster.
285  
286 If this parameter is not provided the resulting cluster will be
287 deployed outside virtual private cloud (VPC).
288  
289  
290  
291 =head2 ClusterType => Str
292  
293 The type of the cluster. When cluster type is specified as
294  
295 =over
296  
297 =item *
298  
299 C<single-node>, the B<NumberOfNodes> parameter is not required.
300  
301 =item *
302  
303 C<multi-node>, the B<NumberOfNodes> parameter is required.
304  
305 =back
306  
307 Valid Values: C<multi-node> | C<single-node>
308  
309 Default: C<multi-node>
310  
311  
312  
313 =head2 ClusterVersion => Str
314  
315 The version of the Amazon Redshift engine software that you want to
316 deploy on the cluster.
317  
318 The version selected runs on all the nodes in the cluster.
319  
320 Constraints: Only version 1.0 is currently available.
321  
322 Example: C<1.0>
323  
324  
325  
326 =head2 DBName => Str
327  
328 The name of the first database to be created when the cluster is
329 created.
330  
331 To create additional databases after the cluster is created, connect to
332 the cluster with a SQL client and use SQL commands to create a
333 database. For more information, go to Create a Database
334 (https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html)
335 in the Amazon Redshift Database Developer Guide.
336  
337 Default: C<dev>
338  
339 Constraints:
340  
341 =over
342  
343 =item *
344  
345 Must contain 1 to 64 alphanumeric characters.
346  
347 =item *
348  
349 Must contain only lowercase letters.
350  
351 =item *
352  
353 Cannot be a word that is reserved by the service. A list of reserved
354 words can be found in Reserved Words
355 (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in
356 the Amazon Redshift Database Developer Guide.
357  
358 =back
359  
360  
361  
362  
363 =head2 ElasticIp => Str
364  
365 The Elastic IP (EIP) address for the cluster.
366  
367 Constraints: The cluster must be provisioned in EC2-VPC and
368 publicly-accessible through an Internet gateway. For more information
369 about provisioning clusters in EC2-VPC, go to Supported Platforms to
370 Launch Your Cluster
371 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms)
372 in the Amazon Redshift Cluster Management Guide.
373  
374  
375  
376 =head2 Encrypted => Bool
377  
378 If C<true>, the data in the cluster is encrypted at rest.
379  
380 Default: false
381  
382  
383  
384 =head2 EnhancedVpcRouting => Bool
385  
386 An option that specifies whether to create the cluster with enhanced
387 VPC routing enabled. To create a cluster that uses enhanced VPC
388 routing, the cluster must be in a VPC. For more information, see
389 Enhanced VPC Routing
390 (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html)
391 in the Amazon Redshift Cluster Management Guide.
392  
393 If this option is C<true>, enhanced VPC routing is enabled.
394  
395 Default: false
396  
397  
398  
399 =head2 HsmClientCertificateIdentifier => Str
400  
401 Specifies the name of the HSM client certificate the Amazon Redshift
402 cluster uses to retrieve the data encryption keys stored in an HSM.
403  
404  
405  
406 =head2 HsmConfigurationIdentifier => Str
407  
408 Specifies the name of the HSM configuration that contains the
409 information the Amazon Redshift cluster can use to retrieve and store
410 keys in an HSM.
411  
412  
413  
414 =head2 IamRoles => ArrayRef[Str|Undef]
415  
416 A list of AWS Identity and Access Management (IAM) roles that can be
417 used by the cluster to access other AWS services. You must supply the
418 IAM roles in their Amazon Resource Name (ARN) format. You can supply up
419 to 10 IAM roles in a single request.
420  
421 A cluster can have up to 10 IAM roles associated with it at any time.
422  
423  
424  
425 =head2 KmsKeyId => Str
426  
427 The AWS Key Management Service (KMS) key ID of the encryption key that
428 you want to use to encrypt data in the cluster.
429  
430  
431  
432 =head2 MaintenanceTrackName => Str
433  
434 An optional parameter for the name of the maintenance track for the
435 cluster. If you don't provide a maintenance track name, the cluster is
436 assigned to the C<current> track.
437  
438  
439  
440 =head2 ManualSnapshotRetentionPeriod => Int
441  
442 The default number of days to retain a manual snapshot. If the value is
443 -1, the snapshot is retained indefinitely. This setting doesn't change
444 the retention period of existing snapshots.
445  
446 The value must be either -1 or an integer between 1 and 3,653.
447  
448  
449  
450 =head2 B<REQUIRED> MasterUsername => Str
451  
452 The user name associated with the master user account for the cluster
453 that is being created.
454  
455 Constraints:
456  
457 =over
458  
459 =item *
460  
461 Must be 1 - 128 alphanumeric characters. The user name can't be
462 C<PUBLIC>.
463  
464 =item *
465  
466 First character must be a letter.
467  
468 =item *
469  
470 Cannot be a reserved word. A list of reserved words can be found in
471 Reserved Words
472 (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in
473 the Amazon Redshift Database Developer Guide.
474  
475 =back
476  
477  
478  
479  
480 =head2 B<REQUIRED> MasterUserPassword => Str
481  
482 The password associated with the master user account for the cluster
483 that is being created.
484  
485 Constraints:
486  
487 =over
488  
489 =item *
490  
491 Must be between 8 and 64 characters in length.
492  
493 =item *
494  
495 Must contain at least one uppercase letter.
496  
497 =item *
498  
499 Must contain at least one lowercase letter.
500  
501 =item *
502  
503 Must contain one number.
504  
505 =item *
506  
507 Can be any printable ASCII character (ASCII code 33 to 126) except '
508 (single quote), " (double quote), \, /, @, or space.
509  
510 =back
511  
512  
513  
514  
515 =head2 B<REQUIRED> NodeType => Str
516  
517 The node type to be provisioned for the cluster. For information about
518 node types, go to Working with Clusters
519 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes)
520 in the I<Amazon Redshift Cluster Management Guide>.
521  
522 Valid Values: C<ds2.xlarge> | C<ds2.8xlarge> | C<dc1.large> |
523 C<dc1.8xlarge> | C<dc2.large> | C<dc2.8xlarge> | C<ra3.xlplus> |
524 C<ra3.4xlarge> | C<ra3.16xlarge>
525  
526  
527  
528 =head2 NumberOfNodes => Int
529  
530 The number of compute nodes in the cluster. This parameter is required
531 when the B<ClusterType> parameter is specified as C<multi-node>.
532  
533 For information about determining how many nodes you need, go to
534 Working with Clusters
535 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes)
536 in the I<Amazon Redshift Cluster Management Guide>.
537  
538 If you don't specify this parameter, you get a single-node cluster.
539 When requesting a multi-node cluster, you must specify the number of
540 nodes that you want in the cluster.
541  
542 Default: C<1>
543  
544 Constraints: Value must be at least 1 and no more than 100.
545  
546  
547  
548 =head2 Port => Int
549  
550 The port number on which the cluster accepts incoming connections.
551  
552 The cluster is accessible only via the JDBC and ODBC connection
553 strings. Part of the connection string requires the port on which the
554 cluster will listen for incoming connections.
555  
556 Default: C<5439>
557  
558 Valid Values: C<1150-65535>
559  
560  
561  
562 =head2 PreferredMaintenanceWindow => Str
563  
564 The weekly time range (in UTC) during which automated cluster
565 maintenance can occur.
566  
567 Format: C<ddd:hh24:mi-ddd:hh24:mi>
568  
569 Default: A 30-minute window selected at random from an 8-hour block of
570 time per region, occurring on a random day of the week. For more
571 information about the time blocks for each region, see Maintenance
572 Windows
573 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows)
574 in Amazon Redshift Cluster Management Guide.
575  
576 Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
577  
578 Constraints: Minimum 30-minute window.
579  
580  
581  
582 =head2 PubliclyAccessible => Bool
583  
584 If C<true>, the cluster can be accessed from a public network.
585  
586  
587  
588 =head2 SnapshotScheduleIdentifier => Str
589  
590 A unique identifier for the snapshot schedule.
591  
592  
593  
594 =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>]
595  
596 A list of tag instances.
597  
598  
599  
600 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
601  
602 A list of Virtual Private Cloud (VPC) security groups to be associated
603 with the cluster.
604  
605 Default: The default VPC security group is associated with the cluster.
606  
607  
608  
609  
610 =head1 SEE ALSO
611  
612 This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::RedShift>
613  
614 =head1 BUGS and CONTRIBUTIONS
615  
616 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
617  
618 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
619  
620 =cut
621  
« blib/lib/Paws/RedShift/CopyClusterSnapshotResult.pm ↑ Summary blib/lib/Paws/RedShift/CreateClusterParameterGroup.pm »