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

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