blib/lib/Paws/Neptune/CreateDBInstance.pm untested

filter: Statementstmt 0.0% 0 / 52 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 54 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Neptune::CreateDBInstance;
3 use Moose;
4 has AllocatedStorage => (is => 'ro', isa => 'Int');
5 has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
6 has AvailabilityZone => (is => 'ro', isa => 'Str');
7 has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
8 has CharacterSetName => (is => 'ro', isa => 'Str');
9 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
10 has DBClusterIdentifier => (is => 'ro', isa => 'Str');
11 has DBInstanceClass => (is => 'ro', isa => 'Str', required => 1);
12 has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
13 has DBName => (is => 'ro', isa => 'Str');
14 has DBParameterGroupName => (is => 'ro', isa => 'Str');
15 has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16 has DBSubnetGroupName => (is => 'ro', isa => 'Str');
17 has DeletionProtection => (is => 'ro', isa => 'Bool');
18 has Domain => (is => 'ro', isa => 'Str');
19 has DomainIAMRoleName => (is => 'ro', isa => 'Str');
20 has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
21 has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
22 has EnablePerformanceInsights => (is => 'ro', isa => 'Bool');
23 has Engine => (is => 'ro', isa => 'Str', required => 1);
24 has EngineVersion => (is => 'ro', isa => 'Str');
25 has Iops => (is => 'ro', isa => 'Int');
26 has KmsKeyId => (is => 'ro', isa => 'Str');
27 has LicenseModel => (is => 'ro', isa => 'Str');
28 has MasterUsername => (is => 'ro', isa => 'Str');
29 has MasterUserPassword => (is => 'ro', isa => 'Str');
30 has MonitoringInterval => (is => 'ro', isa => 'Int');
31 has MonitoringRoleArn => (is => 'ro', isa => 'Str');
32 has MultiAZ => (is => 'ro', isa => 'Bool');
33 has OptionGroupName => (is => 'ro', isa => 'Str');
34 has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str');
35 has Port => (is => 'ro', isa => 'Int');
36 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
37 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
38 has PromotionTier => (is => 'ro', isa => 'Int');
39 has PubliclyAccessible => (is => 'ro', isa => 'Bool');
40 has StorageEncrypted => (is => 'ro', isa => 'Bool');
41 has StorageType => (is => 'ro', isa => 'Str');
42 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Tag]');
43 has TdeCredentialArn => (is => 'ro', isa => 'Str');
44 has TdeCredentialPassword => (is => 'ro', isa => 'Str');
45 has Timezone => (is => 'ro', isa => 'Str');
46 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
47  
48 use MooseX::ClassAttribute;
49  
50 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBInstance');
51 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::CreateDBInstanceResult');
52 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceResult');
53 1;
54  
55 ### main pod documentation begin ###
56  
57 =head1 NAME
58  
59 Paws::Neptune::CreateDBInstance - Arguments for method CreateDBInstance on L<Paws::Neptune>
60  
61 =head1 DESCRIPTION
62  
63 This class represents the parameters used for calling the method CreateDBInstance on the
64 L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class
65 as arguments to method CreateDBInstance.
66  
67 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstance.
68  
69 =head1 SYNOPSIS
70  
71 my $rds = Paws->service('Neptune');
72 my $CreateDBInstanceResult = $rds->CreateDBInstance(
73 DBInstanceClass => 'MyString',
74 DBInstanceIdentifier => 'MyString',
75 Engine => 'MyString',
76 AllocatedStorage => 1, # OPTIONAL
77 AutoMinorVersionUpgrade => 1, # OPTIONAL
78 AvailabilityZone => 'MyString', # OPTIONAL
79 BackupRetentionPeriod => 1, # OPTIONAL
80 CharacterSetName => 'MyString', # OPTIONAL
81 CopyTagsToSnapshot => 1, # OPTIONAL
82 DBClusterIdentifier => 'MyString', # OPTIONAL
83 DBName => 'MyString', # OPTIONAL
84 DBParameterGroupName => 'MyString', # OPTIONAL
85 DBSecurityGroups => [ 'MyString', ... ], # OPTIONAL
86 DBSubnetGroupName => 'MyString', # OPTIONAL
87 DeletionProtection => 1, # OPTIONAL
88 Domain => 'MyString', # OPTIONAL
89 DomainIAMRoleName => 'MyString', # OPTIONAL
90 EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL
91 EnableIAMDatabaseAuthentication => 1, # OPTIONAL
92 EnablePerformanceInsights => 1, # OPTIONAL
93 EngineVersion => 'MyString', # OPTIONAL
94 Iops => 1, # OPTIONAL
95 KmsKeyId => 'MyString', # OPTIONAL
96 LicenseModel => 'MyString', # OPTIONAL
97 MasterUserPassword => 'MyString', # OPTIONAL
98 MasterUsername => 'MyString', # OPTIONAL
99 MonitoringInterval => 1, # OPTIONAL
100 MonitoringRoleArn => 'MyString', # OPTIONAL
101 MultiAZ => 1, # OPTIONAL
102 OptionGroupName => 'MyString', # OPTIONAL
103 PerformanceInsightsKMSKeyId => 'MyString', # OPTIONAL
104 Port => 1, # OPTIONAL
105 PreferredBackupWindow => 'MyString', # OPTIONAL
106 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
107 PromotionTier => 1, # OPTIONAL
108 PubliclyAccessible => 1, # OPTIONAL
109 StorageEncrypted => 1, # OPTIONAL
110 StorageType => 'MyString', # OPTIONAL
111 Tags => [
112 {
113 Key => 'MyString',
114 Value => 'MyString',
115 },
116 ...
117 ], # OPTIONAL
118 TdeCredentialArn => 'MyString', # OPTIONAL
119 TdeCredentialPassword => 'MyString', # OPTIONAL
120 Timezone => 'MyString', # OPTIONAL
121 VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL
122 );
123  
124 # Results:
125 my $DBInstance = $CreateDBInstanceResult->DBInstance;
126  
127 # Returns a L<Paws::Neptune::CreateDBInstanceResult> object.
128  
129 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.
130 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBInstance>
131  
132 =head1 ATTRIBUTES
133  
134  
135 =head2 AllocatedStorage => Int
136  
137 Not supported by Neptune.
138  
139  
140  
141 =head2 AutoMinorVersionUpgrade => Bool
142  
143 Indicates that minor engine upgrades are applied automatically to the
144 DB instance during the maintenance window.
145  
146 Default: C<true>
147  
148  
149  
150 =head2 AvailabilityZone => Str
151  
152 The EC2 Availability Zone that the DB instance is created in
153  
154 Default: A random, system-chosen Availability Zone in the endpoint's
155 Amazon Region.
156  
157 Example: C<us-east-1d>
158  
159 Constraint: The AvailabilityZone parameter can't be specified if the
160 MultiAZ parameter is set to C<true>. The specified Availability Zone
161 must be in the same Amazon Region as the current endpoint.
162  
163  
164  
165 =head2 BackupRetentionPeriod => Int
166  
167 The number of days for which automated backups are retained.
168  
169 Not applicable. The retention period for automated backups is managed
170 by the DB cluster. For more information, see CreateDBCluster.
171  
172 Default: 1
173  
174 Constraints:
175  
176 =over
177  
178 =item *
179  
180 Must be a value from 0 to 35
181  
182 =item *
183  
184 Cannot be set to 0 if the DB instance is a source to Read Replicas
185  
186 =back
187  
188  
189  
190  
191 =head2 CharacterSetName => Str
192  
193 I<(Not supported by Neptune)>
194  
195  
196  
197 =head2 CopyTagsToSnapshot => Bool
198  
199 True to copy all tags from the DB instance to snapshots of the DB
200 instance, and otherwise false. The default is false.
201  
202  
203  
204 =head2 DBClusterIdentifier => Str
205  
206 The identifier of the DB cluster that the instance will belong to.
207  
208 For information on creating a DB cluster, see CreateDBCluster.
209  
210 Type: String
211  
212  
213  
214 =head2 B<REQUIRED> DBInstanceClass => Str
215  
216 The compute and memory capacity of the DB instance, for example,
217 C<db.m4.large>. Not all DB instance classes are available in all Amazon
218 Regions.
219  
220  
221  
222 =head2 B<REQUIRED> DBInstanceIdentifier => Str
223  
224 The DB instance identifier. This parameter is stored as a lowercase
225 string.
226  
227 Constraints:
228  
229 =over
230  
231 =item *
232  
233 Must contain from 1 to 63 letters, numbers, or hyphens.
234  
235 =item *
236  
237 First character must be a letter.
238  
239 =item *
240  
241 Cannot end with a hyphen or contain two consecutive hyphens.
242  
243 =back
244  
245 Example: C<mydbinstance>
246  
247  
248  
249 =head2 DBName => Str
250  
251 Not supported.
252  
253  
254  
255 =head2 DBParameterGroupName => Str
256  
257 The name of the DB parameter group to associate with this DB instance.
258 If this argument is omitted, the default DBParameterGroup for the
259 specified engine is used.
260  
261 Constraints:
262  
263 =over
264  
265 =item *
266  
267 Must be 1 to 255 letters, numbers, or hyphens.
268  
269 =item *
270  
271 First character must be a letter
272  
273 =item *
274  
275 Cannot end with a hyphen or contain two consecutive hyphens
276  
277 =back
278  
279  
280  
281  
282 =head2 DBSecurityGroups => ArrayRef[Str|Undef]
283  
284 A list of DB security groups to associate with this DB instance.
285  
286 Default: The default DB security group for the database engine.
287  
288  
289  
290 =head2 DBSubnetGroupName => Str
291  
292 A DB subnet group to associate with this DB instance.
293  
294 If there is no DB subnet group, then it is a non-VPC DB instance.
295  
296  
297  
298 =head2 DeletionProtection => Bool
299  
300 A value that indicates whether the DB instance has deletion protection
301 enabled. The database can't be deleted when deletion protection is
302 enabled. By default, deletion protection is disabled. See Deleting a DB
303 Instance
304 (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
305  
306 DB instances in a DB cluster can be deleted even when deletion
307 protection is enabled in their parent DB cluster.
308  
309  
310  
311 =head2 Domain => Str
312  
313 Specify the Active Directory Domain to create the instance in.
314  
315  
316  
317 =head2 DomainIAMRoleName => Str
318  
319 Specify the name of the IAM role to be used when making API calls to
320 the Directory Service.
321  
322  
323  
324 =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef]
325  
326 The list of log types that need to be enabled for exporting to
327 CloudWatch Logs.
328  
329  
330  
331 =head2 EnableIAMDatabaseAuthentication => Bool
332  
333 Not supported by Neptune (ignored).
334  
335  
336  
337 =head2 EnablePerformanceInsights => Bool
338  
339 I<(Not supported by Neptune)>
340  
341  
342  
343 =head2 B<REQUIRED> Engine => Str
344  
345 The name of the database engine to be used for this instance.
346  
347 Valid Values: C<neptune>
348  
349  
350  
351 =head2 EngineVersion => Str
352  
353 The version number of the database engine to use. Currently, setting
354 this parameter has no effect.
355  
356  
357  
358 =head2 Iops => Int
359  
360 The amount of Provisioned IOPS (input/output operations per second) to
361 be initially allocated for the DB instance.
362  
363  
364  
365 =head2 KmsKeyId => Str
366  
367 The Amazon KMS key identifier for an encrypted DB instance.
368  
369 The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
370 encryption key. If you are creating a DB instance with the same Amazon
371 account that owns the KMS encryption key used to encrypt the new DB
372 instance, then you can use the KMS key alias instead of the ARN for the
373 KM encryption key.
374  
375 Not applicable. The KMS key identifier is managed by the DB cluster.
376 For more information, see CreateDBCluster.
377  
378 If the C<StorageEncrypted> parameter is true, and you do not specify a
379 value for the C<KmsKeyId> parameter, then Amazon Neptune will use your
380 default encryption key. Amazon KMS creates the default encryption key
381 for your Amazon account. Your Amazon account has a different default
382 encryption key for each Amazon Region.
383  
384  
385  
386 =head2 LicenseModel => Str
387  
388 License model information for this DB instance.
389  
390 Valid values: C<license-included> | C<bring-your-own-license> |
391 C<general-public-license>
392  
393  
394  
395 =head2 MasterUsername => Str
396  
397 Not supported by Neptune.
398  
399  
400  
401 =head2 MasterUserPassword => Str
402  
403 Not supported by Neptune.
404  
405  
406  
407 =head2 MonitoringInterval => Int
408  
409 The interval, in seconds, between points when Enhanced Monitoring
410 metrics are collected for the DB instance. To disable collecting
411 Enhanced Monitoring metrics, specify 0. The default is 0.
412  
413 If C<MonitoringRoleArn> is specified, then you must also set
414 C<MonitoringInterval> to a value other than 0.
415  
416 Valid Values: C<0, 1, 5, 10, 15, 30, 60>
417  
418  
419  
420 =head2 MonitoringRoleArn => Str
421  
422 The ARN for the IAM role that permits Neptune to send enhanced
423 monitoring metrics to Amazon CloudWatch Logs. For example,
424 C<arn:aws:iam:123456789012:role/emaccess>.
425  
426 If C<MonitoringInterval> is set to a value other than 0, then you must
427 supply a C<MonitoringRoleArn> value.
428  
429  
430  
431 =head2 MultiAZ => Bool
432  
433 Specifies if the DB instance is a Multi-AZ deployment. You can't set
434 the AvailabilityZone parameter if the MultiAZ parameter is set to true.
435  
436  
437  
438 =head2 OptionGroupName => Str
439  
440 I<(Not supported by Neptune)>
441  
442  
443  
444 =head2 PerformanceInsightsKMSKeyId => Str
445  
446 I<(Not supported by Neptune)>
447  
448  
449  
450 =head2 Port => Int
451  
452 The port number on which the database accepts connections.
453  
454 Not applicable. The port is managed by the DB cluster. For more
455 information, see CreateDBCluster.
456  
457 Default: C<8182>
458  
459 Type: Integer
460  
461  
462  
463 =head2 PreferredBackupWindow => Str
464  
465 The daily time range during which automated backups are created.
466  
467 Not applicable. The daily time range for creating automated backups is
468 managed by the DB cluster. For more information, see CreateDBCluster.
469  
470  
471  
472 =head2 PreferredMaintenanceWindow => Str
473  
474 The time range each week during which system maintenance can occur, in
475 Universal Coordinated Time (UTC).
476  
477 Format: C<ddd:hh24:mi-ddd:hh24:mi>
478  
479 The default is a 30-minute window selected at random from an 8-hour
480 block of time for each Amazon Region, occurring on a random day of the
481 week.
482  
483 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
484  
485 Constraints: Minimum 30-minute window.
486  
487  
488  
489 =head2 PromotionTier => Int
490  
491 A value that specifies the order in which an Read Replica is promoted
492 to the primary instance after a failure of the existing primary
493 instance.
494  
495 Default: 1
496  
497 Valid Values: 0 - 15
498  
499  
500  
501 =head2 PubliclyAccessible => Bool
502  
503 This flag should no longer be used.
504  
505  
506  
507 =head2 StorageEncrypted => Bool
508  
509 Specifies whether the DB instance is encrypted.
510  
511 Not applicable. The encryption for DB instances is managed by the DB
512 cluster. For more information, see CreateDBCluster.
513  
514 Default: false
515  
516  
517  
518 =head2 StorageType => Str
519  
520 Specifies the storage type to be associated with the DB instance.
521  
522 Not applicable. Storage is managed by the DB Cluster.
523  
524  
525  
526 =head2 Tags => ArrayRef[L<Paws::Neptune::Tag>]
527  
528 The tags to assign to the new instance.
529  
530  
531  
532 =head2 TdeCredentialArn => Str
533  
534 The ARN from the key store with which to associate the instance for TDE
535 encryption.
536  
537  
538  
539 =head2 TdeCredentialPassword => Str
540  
541 The password for the given ARN from the key store in order to access
542 the device.
543  
544  
545  
546 =head2 Timezone => Str
547  
548 The time zone of the DB instance.
549  
550  
551  
552 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
553  
554 A list of EC2 VPC security groups to associate with this DB instance.
555  
556 Not applicable. The associated list of EC2 VPC security groups is
557 managed by the DB cluster. For more information, see CreateDBCluster.
558  
559 Default: The default EC2 VPC security group for the DB subnet group's
560 VPC.
561  
562  
563  
564  
565 =head1 SEE ALSO
566  
567 This class forms part of L<Paws>, documenting arguments for method CreateDBInstance in L<Paws::Neptune>
568  
569 =head1 BUGS and CONTRIBUTIONS
570  
571 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
572  
573 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
574  
575 =cut
576