blib/lib/Paws/DocDB/CreateDBCluster.pm untested

filter: Statementstmt 0.0% 0 / 29 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 31 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DocDB::CreateDBCluster;
3 use Moose;
4 has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
6 has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
7 has DBClusterParameterGroupName => (is => 'ro', isa => 'Str');
8 has DBSubnetGroupName => (is => 'ro', isa => 'Str');
9 has DeletionProtection => (is => 'ro', isa => 'Bool');
10 has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
11 has Engine => (is => 'ro', isa => 'Str', required => 1);
12 has EngineVersion => (is => 'ro', isa => 'Str');
13 has GlobalClusterIdentifier => (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 Port => (is => 'ro', isa => 'Int');
18 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
19 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
20 has PreSignedUrl => (is => 'ro', isa => 'Str');
21 has StorageEncrypted => (is => 'ro', isa => 'Bool');
22 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Tag]');
23 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
24  
25 use MooseX::ClassAttribute;
26  
27 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBCluster');
28 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::CreateDBClusterResult');
29 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBClusterResult');
30 1;
31  
32 ### main pod documentation begin ###
33  
34 =head1 NAME
35  
36 Paws::DocDB::CreateDBCluster - Arguments for method CreateDBCluster on L<Paws::DocDB>
37  
38 =head1 DESCRIPTION
39  
40 This class represents the parameters used for calling the method CreateDBCluster on the
41 L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class
42 as arguments to method CreateDBCluster.
43  
44 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBCluster.
45  
46 =head1 SYNOPSIS
47  
48 my $rds = Paws->service('DocDB');
49 my $CreateDBClusterResult = $rds->CreateDBCluster(
50 DBClusterIdentifier => 'MyString',
51 Engine => 'MyString',
52 AvailabilityZones => [ 'MyString', ... ], # OPTIONAL
53 BackupRetentionPeriod => 1, # OPTIONAL
54 DBClusterParameterGroupName => 'MyString', # OPTIONAL
55 DBSubnetGroupName => 'MyString', # OPTIONAL
56 DeletionProtection => 1, # OPTIONAL
57 EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL
58 EngineVersion => 'MyString', # OPTIONAL
59 GlobalClusterIdentifier => 'MyGlobalClusterIdentifier', # OPTIONAL
60 KmsKeyId => 'MyString', # OPTIONAL
61 MasterUserPassword => 'MyString', # OPTIONAL
62 MasterUsername => 'MyString', # OPTIONAL
63 Port => 1, # OPTIONAL
64 PreSignedUrl => 'MyString', # OPTIONAL
65 PreferredBackupWindow => 'MyString', # OPTIONAL
66 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
67 StorageEncrypted => 1, # OPTIONAL
68 Tags => [
69 {
70 Key => 'MyString',
71 Value => 'MyString',
72 },
73 ...
74 ], # OPTIONAL
75 VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL
76 );
77  
78 # Results:
79 my $DBCluster = $CreateDBClusterResult->DBCluster;
80  
81 # Returns a L<Paws::DocDB::CreateDBClusterResult> object.
82  
83 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.
84 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBCluster>
85  
86 =head1 ATTRIBUTES
87  
88  
89 =head2 AvailabilityZones => ArrayRef[Str|Undef]
90  
91 A list of Amazon EC2 Availability Zones that instances in the cluster
92 can be created in.
93  
94  
95  
96 =head2 BackupRetentionPeriod => Int
97  
98 The number of days for which automated backups are retained. You must
99 specify a minimum value of 1.
100  
101 Default: 1
102  
103 Constraints:
104  
105 =over
106  
107 =item *
108  
109 Must be a value from 1 to 35.
110  
111 =back
112  
113  
114  
115  
116 =head2 B<REQUIRED> DBClusterIdentifier => Str
117  
118 The cluster identifier. This parameter is stored as a lowercase string.
119  
120 Constraints:
121  
122 =over
123  
124 =item *
125  
126 Must contain from 1 to 63 letters, numbers, or hyphens.
127  
128 =item *
129  
130 The first character must be a letter.
131  
132 =item *
133  
134 Cannot end with a hyphen or contain two consecutive hyphens.
135  
136 =back
137  
138 Example: C<my-cluster>
139  
140  
141  
142 =head2 DBClusterParameterGroupName => Str
143  
144 The name of the cluster parameter group to associate with this cluster.
145  
146  
147  
148 =head2 DBSubnetGroupName => Str
149  
150 A subnet group to associate with this cluster.
151  
152 Constraints: Must match the name of an existing C<DBSubnetGroup>. Must
153 not be default.
154  
155 Example: C<mySubnetgroup>
156  
157  
158  
159 =head2 DeletionProtection => Bool
160  
161 Specifies whether this cluster can be deleted. If C<DeletionProtection>
162 is enabled, the cluster cannot be deleted unless it is modified and
163 C<DeletionProtection> is disabled. C<DeletionProtection> protects
164 clusters from being accidentally deleted.
165  
166  
167  
168 =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef]
169  
170 A list of log types that need to be enabled for exporting to Amazon
171 CloudWatch Logs. You can enable audit logs or profiler logs. For more
172 information, see Auditing Amazon DocumentDB Events
173 (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)
174 and Profiling Amazon DocumentDB Operations
175 (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).
176  
177  
178  
179 =head2 B<REQUIRED> Engine => Str
180  
181 The name of the database engine to be used for this cluster.
182  
183 Valid values: C<docdb>
184  
185  
186  
187 =head2 EngineVersion => Str
188  
189 The version number of the database engine to use. The
190 C<--engine-version> will default to the latest major engine version.
191 For production workloads, we recommend explicitly declaring this
192 parameter with the intended major engine version.
193  
194  
195  
196 =head2 GlobalClusterIdentifier => Str
197  
198 The cluster identifier of the new global cluster.
199  
200  
201  
202 =head2 KmsKeyId => Str
203  
204 The KMS key identifier for an encrypted cluster.
205  
206 The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
207 encryption key. If you are creating a cluster using the same account
208 that owns the KMS encryption key that is used to encrypt the new
209 cluster, you can use the KMS key alias instead of the ARN for the KMS
210 encryption key.
211  
212 If an encryption key is not specified in C<KmsKeyId>:
213  
214 =over
215  
216 =item *
217  
218 If the C<StorageEncrypted> parameter is C<true>, Amazon DocumentDB uses
219 your default encryption key.
220  
221 =back
222  
223 KMS creates the default encryption key for your account. Your account
224 has a different default encryption key for each Regions.
225  
226  
227  
228 =head2 MasterUsername => Str
229  
230 The name of the master user for the cluster.
231  
232 Constraints:
233  
234 =over
235  
236 =item *
237  
238 Must be from 1 to 63 letters or numbers.
239  
240 =item *
241  
242 The first character must be a letter.
243  
244 =item *
245  
246 Cannot be a reserved word for the chosen database engine.
247  
248 =back
249  
250  
251  
252  
253 =head2 MasterUserPassword => Str
254  
255 The password for the master database user. This password can contain
256 any printable ASCII character except forward slash (/), double quote
257 ("), or the "at" symbol (@).
258  
259 Constraints: Must contain from 8 to 100 characters.
260  
261  
262  
263 =head2 Port => Int
264  
265 The port number on which the instances in the cluster accept
266 connections.
267  
268  
269  
270 =head2 PreferredBackupWindow => Str
271  
272 The daily time range during which automated backups are created if
273 automated backups are enabled using the C<BackupRetentionPeriod>
274 parameter.
275  
276 The default is a 30-minute window selected at random from an 8-hour
277 block of time for each Region.
278  
279 Constraints:
280  
281 =over
282  
283 =item *
284  
285 Must be in the format C<hh24:mi-hh24:mi>.
286  
287 =item *
288  
289 Must be in Universal Coordinated Time (UTC).
290  
291 =item *
292  
293 Must not conflict with the preferred maintenance window.
294  
295 =item *
296  
297 Must be at least 30 minutes.
298  
299 =back
300  
301  
302  
303  
304 =head2 PreferredMaintenanceWindow => Str
305  
306 The weekly time range during which system maintenance can occur, in
307 Universal Coordinated Time (UTC).
308  
309 Format: C<ddd:hh24:mi-ddd:hh24:mi>
310  
311 The default is a 30-minute window selected at random from an 8-hour
312 block of time for each Region, occurring on a random day of the week.
313  
314 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
315  
316 Constraints: Minimum 30-minute window.
317  
318  
319  
320 =head2 PreSignedUrl => Str
321  
322 Not currently supported.
323  
324  
325  
326 =head2 StorageEncrypted => Bool
327  
328 Specifies whether the cluster is encrypted.
329  
330  
331  
332 =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>]
333  
334 The tags to be assigned to the cluster.
335  
336  
337  
338 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
339  
340 A list of EC2 VPC security groups to associate with this cluster.
341  
342  
343  
344  
345 =head1 SEE ALSO
346  
347 This class forms part of L<Paws>, documenting arguments for method CreateDBCluster in L<Paws::DocDB>
348  
349 =head1 BUGS and CONTRIBUTIONS
350  
351 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
352  
353 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
354  
355 =cut
356