File Coverage

blib/lib/Paws/RDS/CreateDBCluster.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              
2             package Paws::RDS::CreateDBCluster;
3 1     1   399 use Moose;
  1         3  
  1         5  
4             has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
6             has CharacterSetName => (is => 'ro', isa => 'Str');
7             has DatabaseName => (is => 'ro', isa => 'Str');
8             has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
9             has DBClusterParameterGroupName => (is => 'ro', isa => 'Str');
10             has DBSubnetGroupName => (is => 'ro', isa => 'Str');
11             has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
12             has Engine => (is => 'ro', isa => 'Str', required => 1);
13             has EngineVersion => (is => 'ro', isa => 'Str');
14             has KmsKeyId => (is => 'ro', isa => 'Str');
15             has MasterUsername => (is => 'ro', isa => 'Str');
16             has MasterUserPassword => (is => 'ro', isa => 'Str');
17             has OptionGroupName => (is => 'ro', isa => 'Str');
18             has Port => (is => 'ro', isa => 'Int');
19             has PreferredBackupWindow => (is => 'ro', isa => 'Str');
20             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
21             has PreSignedUrl => (is => 'ro', isa => 'Str');
22             has ReplicationSourceIdentifier => (is => 'ro', isa => 'Str');
23             has StorageEncrypted => (is => 'ro', isa => 'Bool');
24             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
25             has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
26              
27 1     1   5862 use MooseX::ClassAttribute;
  1         3  
  1         9  
28              
29             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBCluster');
30             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateDBClusterResult');
31             class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBClusterResult');
32             1;
33              
34             ### main pod documentation begin ###
35              
36             =head1 NAME
37              
38             Paws::RDS::CreateDBCluster - Arguments for method CreateDBCluster on Paws::RDS
39              
40             =head1 DESCRIPTION
41              
42             This class represents the parameters used for calling the method CreateDBCluster on the
43             Amazon Relational Database Service service. Use the attributes of this class
44             as arguments to method CreateDBCluster.
45              
46             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBCluster.
47              
48             As an example:
49              
50             $service_obj->CreateDBCluster(Att1 => $value1, Att2 => $value2, ...);
51              
52             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.
53              
54             =head1 ATTRIBUTES
55              
56              
57             =head2 AvailabilityZones => ArrayRef[Str|Undef]
58              
59             A list of EC2 Availability Zones that instances in the DB cluster can
60             be created in. For information on regions and Availability Zones, see
61             Regions and Availability Zones.
62              
63              
64              
65             =head2 BackupRetentionPeriod => Int
66              
67             The number of days for which automated backups are retained. You must
68             specify a minimum value of 1.
69              
70             Default: 1
71              
72             Constraints:
73              
74             =over
75              
76             =item *
77              
78             Must be a value from 1 to 35
79              
80             =back
81              
82              
83              
84              
85             =head2 CharacterSetName => Str
86              
87             A value that indicates that the DB cluster should be associated with
88             the specified CharacterSet.
89              
90              
91              
92             =head2 DatabaseName => Str
93              
94             The name for your database of up to 64 alpha-numeric characters. If you
95             do not provide a name, Amazon RDS will not create a database in the DB
96             cluster you are creating.
97              
98              
99              
100             =head2 B<REQUIRED> DBClusterIdentifier => Str
101              
102             The DB cluster identifier. This parameter is stored as a lowercase
103             string.
104              
105             Constraints:
106              
107             =over
108              
109             =item *
110              
111             Must contain from 1 to 63 alphanumeric characters or hyphens.
112              
113             =item *
114              
115             First character must be a letter.
116              
117             =item *
118              
119             Cannot end with a hyphen or contain two consecutive hyphens.
120              
121             =back
122              
123             Example: C<my-cluster1>
124              
125              
126              
127             =head2 DBClusterParameterGroupName => Str
128              
129             The name of the DB cluster parameter group to associate with this DB
130             cluster. If this argument is omitted, C<default.aurora5.6> will be
131             used.
132              
133             Constraints:
134              
135             =over
136              
137             =item *
138              
139             Must be 1 to 255 alphanumeric characters
140              
141             =item *
142              
143             First character must be a letter
144              
145             =item *
146              
147             Cannot end with a hyphen or contain two consecutive hyphens
148              
149             =back
150              
151              
152              
153              
154             =head2 DBSubnetGroupName => Str
155              
156             A DB subnet group to associate with this DB cluster.
157              
158             Constraints: Must contain no more than 255 alphanumeric characters,
159             periods, underscores, spaces, or hyphens. Must not be default.
160              
161             Example: C<mySubnetgroup>
162              
163              
164              
165             =head2 EnableIAMDatabaseAuthentication => Bool
166              
167             A Boolean value that is true to enable mapping of AWS Identity and
168             Access Management (IAM) accounts to database accounts, and otherwise
169             false.
170              
171             Default: C<false>
172              
173              
174              
175             =head2 B<REQUIRED> Engine => Str
176              
177             The name of the database engine to be used for this DB cluster.
178              
179             Valid Values: C<aurora>
180              
181              
182              
183             =head2 EngineVersion => Str
184              
185             The version number of the database engine to use.
186              
187             B<Aurora>
188              
189             Example: C<5.6.10a>
190              
191              
192              
193             =head2 KmsKeyId => Str
194              
195             The KMS key identifier for an encrypted DB cluster.
196              
197             The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
198             encryption key. If you are creating a DB cluster with the same AWS
199             account that owns the KMS encryption key used to encrypt the new DB
200             cluster, then you can use the KMS key alias instead of the ARN for the
201             KMS encryption key.
202              
203             If an encryption key is not specified in C<KmsKeyId>:
204              
205             =over
206              
207             =item *
208              
209             If C<ReplicationSourceIdentifier> identifies an encrypted source, then
210             Amazon RDS will use the encryption key used to encrypt the source.
211             Otherwise, Amazon RDS will use your default encryption key.
212              
213             =item *
214              
215             If the C<StorageEncrypted> parameter is true and
216             C<ReplicationSourceIdentifier> is not specified, then Amazon RDS will
217             use your default encryption key.
218              
219             =back
220              
221             AWS KMS creates the default encryption key for your AWS account. Your
222             AWS account has a different default encryption key for each AWS Region.
223              
224             If you create a Read Replica of an encrypted DB cluster in another AWS
225             Region, you must set C<KmsKeyId> to a KMS key ID that is valid in the
226             destination AWS Region. This key is used to encrypt the Read Replica in
227             that AWS Region.
228              
229              
230              
231             =head2 MasterUsername => Str
232              
233             The name of the master user for the DB cluster.
234              
235             Constraints:
236              
237             =over
238              
239             =item *
240              
241             Must be 1 to 16 alphanumeric characters.
242              
243             =item *
244              
245             First character must be a letter.
246              
247             =item *
248              
249             Cannot be a reserved word for the chosen database engine.
250              
251             =back
252              
253              
254              
255              
256             =head2 MasterUserPassword => Str
257              
258             The password for the master database user. This password can contain
259             any printable ASCII character except "/", """, or "@".
260              
261             Constraints: Must contain from 8 to 41 characters.
262              
263              
264              
265             =head2 OptionGroupName => Str
266              
267             A value that indicates that the DB cluster should be associated with
268             the specified option group.
269              
270             Permanent options cannot be removed from an option group. The option
271             group cannot be removed from a DB cluster once it is associated with a
272             DB cluster.
273              
274              
275              
276             =head2 Port => Int
277              
278             The port number on which the instances in the DB cluster accept
279             connections.
280              
281             Default: C<3306>
282              
283              
284              
285             =head2 PreferredBackupWindow => Str
286              
287             The daily time range during which automated backups are created if
288             automated backups are enabled using the C<BackupRetentionPeriod>
289             parameter.
290              
291             Default: A 30-minute window selected at random from an 8-hour block of
292             time per AWS Region. To see the time blocks available, see Adjusting
293             the Preferred Maintenance Window in the I<Amazon RDS User Guide.>
294              
295             Constraints:
296              
297             =over
298              
299             =item *
300              
301             Must be in the format C<hh24:mi-hh24:mi>.
302              
303             =item *
304              
305             Times should be in Universal Coordinated Time (UTC).
306              
307             =item *
308              
309             Must not conflict with the preferred maintenance window.
310              
311             =item *
312              
313             Must be at least 30 minutes.
314              
315             =back
316              
317              
318              
319              
320             =head2 PreferredMaintenanceWindow => Str
321              
322             The weekly time range during which system maintenance can occur, in
323             Universal Coordinated Time (UTC).
324              
325             Format: C<ddd:hh24:mi-ddd:hh24:mi>
326              
327             Default: A 30-minute window selected at random from an 8-hour block of
328             time per AWS Region, occurring on a random day of the week. To see the
329             time blocks available, see Adjusting the Preferred Maintenance Window
330             in the I<Amazon RDS User Guide.>
331              
332             Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
333              
334             Constraints: Minimum 30-minute window.
335              
336              
337              
338             =head2 PreSignedUrl => Str
339              
340             A URL that contains a Signature Version 4 signed request for the
341             C<CreateDBCluster> action to be called in the source AWS Region where
342             the DB cluster will be replicated from. You only need to specify
343             C<PreSignedUrl> when you are performing cross-region replication from
344             an encrypted DB cluster.
345              
346             The pre-signed URL must be a valid request for the C<CreateDBCluster>
347             API action that can be executed in the source AWS Region that contains
348             the encrypted DB cluster to be copied.
349              
350             The pre-signed URL request must contain the following parameter values:
351              
352             =over
353              
354             =item *
355              
356             C<KmsKeyId> - The KMS key identifier for the key to use to encrypt the
357             copy of the DB cluster in the destination AWS Region. This should refer
358             to the same KMS key for both the C<CreateDBCluster> action that is
359             called in the destination AWS Region, and the action contained in the
360             pre-signed URL.
361              
362             =item *
363              
364             C<DestinationRegion> - The name of the AWS Region that Aurora Read
365             Replica will be created in.
366              
367             =item *
368              
369             C<ReplicationSourceIdentifier> - The DB cluster identifier for the
370             encrypted DB cluster to be copied. This identifier must be in the
371             Amazon Resource Name (ARN) format for the source AWS Region. For
372             example, if you are copying an encrypted DB cluster from the us-west-2
373             region, then your C<ReplicationSourceIdentifier> would look like
374             Example: C<arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1>.
375              
376             =back
377              
378             To learn how to generate a Signature Version 4 signed request, see
379             Authenticating Requests: Using Query Parameters (AWS Signature Version
380             4) and Signature Version 4 Signing Process.
381              
382              
383              
384             =head2 ReplicationSourceIdentifier => Str
385              
386             The Amazon Resource Name (ARN) of the source DB instance or DB cluster
387             if this DB cluster is created as a Read Replica.
388              
389              
390              
391             =head2 StorageEncrypted => Bool
392              
393             Specifies whether the DB cluster is encrypted.
394              
395              
396              
397             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
398              
399              
400              
401              
402              
403             =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
404              
405             A list of EC2 VPC security groups to associate with this DB cluster.
406              
407              
408              
409              
410             =head1 SEE ALSO
411              
412             This class forms part of L<Paws>, documenting arguments for method CreateDBCluster in L<Paws::RDS>
413              
414             =head1 BUGS and CONTRIBUTIONS
415              
416             The source code is located here: https://github.com/pplu/aws-sdk-perl
417              
418             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
419              
420             =cut
421