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

filter: Statementstmt 0.0% 0 / 54 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 56 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::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 AwsBackupRecoveryPointArn => (is => 'ro', isa => 'Str');
9 has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
10 has CACertificateIdentifier => (is => 'ro', isa => 'Str');
11 has CertificateRotationRestart => (is => 'ro', isa => 'Bool');
12 has CloudwatchLogsExportConfiguration => (is => 'ro', isa => 'Paws::RDS::CloudwatchLogsExportConfiguration');
13 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
14 has DBInstanceClass => (is => 'ro', isa => 'Str');
15 has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
16 has DBParameterGroupName => (is => 'ro', isa => 'Str');
17 has DBPortNumber => (is => 'ro', isa => 'Int');
18 has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
19 has DBSubnetGroupName => (is => 'ro', isa => 'Str');
20 has DeletionProtection => (is => 'ro', isa => 'Bool');
21 has Domain => (is => 'ro', isa => 'Str');
22 has DomainIAMRoleName => (is => 'ro', isa => 'Str');
23 has EnableCustomerOwnedIp => (is => 'ro', isa => 'Bool');
24 has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
25 has EnablePerformanceInsights => (is => 'ro', isa => 'Bool');
26 has EngineVersion => (is => 'ro', isa => 'Str');
27 has Iops => (is => 'ro', isa => 'Int');
28 has LicenseModel => (is => 'ro', isa => 'Str');
29 has MasterUserPassword => (is => 'ro', isa => 'Str');
30 has MaxAllocatedStorage => (is => 'ro', isa => 'Int');
31 has MonitoringInterval => (is => 'ro', isa => 'Int');
32 has MonitoringRoleArn => (is => 'ro', isa => 'Str');
33 has MultiAZ => (is => 'ro', isa => 'Bool');
34 has NewDBInstanceIdentifier => (is => 'ro', isa => 'Str');
35 has OptionGroupName => (is => 'ro', isa => 'Str');
36 has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str');
37 has PerformanceInsightsRetentionPeriod => (is => 'ro', isa => 'Int');
38 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
39 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
40 has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]');
41 has PromotionTier => (is => 'ro', isa => 'Int');
42 has PubliclyAccessible => (is => 'ro', isa => 'Bool');
43 has ReplicaMode => (is => 'ro', isa => 'Str');
44 has StorageType => (is => 'ro', isa => 'Str');
45 has TdeCredentialArn => (is => 'ro', isa => 'Str');
46 has TdeCredentialPassword => (is => 'ro', isa => 'Str');
47 has UseDefaultProcessorFeatures => (is => 'ro', isa => 'Bool');
48 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
49  
50 use MooseX::ClassAttribute;
51  
52 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBInstance');
53 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyDBInstanceResult');
54 class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBInstanceResult');
55 1;
56  
57 ### main pod documentation begin ###
58  
59 =head1 NAME
60  
61 Paws::RDS::ModifyDBInstance - Arguments for method ModifyDBInstance on L<Paws::RDS>
62  
63 =head1 DESCRIPTION
64  
65 This class represents the parameters used for calling the method ModifyDBInstance on the
66 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
67 as arguments to method ModifyDBInstance.
68  
69 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBInstance.
70  
71 =head1 SYNOPSIS
72  
73 my $rds = Paws->service('RDS');
74 # To change DB instance settings
75 # This example immediately changes the specified settings for the specified DB
76 # instance.
77 my $ModifyDBInstanceResult = $rds->ModifyDBInstance(
78 'AllocatedStorage' => 10,
79 'ApplyImmediately' => 1,
80 'BackupRetentionPeriod' => 1,
81 'DBInstanceClass' => 'db.t2.small',
82 'DBInstanceIdentifier' => 'mymysqlinstance',
83 'MasterUserPassword' => 'mynewpassword',
84 'PreferredBackupWindow' => '04:00-04:30',
85 'PreferredMaintenanceWindow' => 'Tue:05:00-Tue:05:30'
86 );
87  
88 # Results:
89 my $DBInstance = $ModifyDBInstanceResult->DBInstance;
90  
91 # Returns a L<Paws::RDS::ModifyDBInstanceResult> object.
92  
93 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.
94 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBInstance>
95  
96 =head1 ATTRIBUTES
97  
98  
99 =head2 AllocatedStorage => Int
100  
101 The new amount of storage (in gibibytes) to allocate for the DB
102 instance.
103  
104 For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be
105 at least 10% greater than the current value. Values that are not at
106 least 10% greater than the existing value are rounded up so that they
107 are 10% greater than the current value.
108  
109 For the valid values for allocated storage for each engine, see
110 C<CreateDBInstance>.
111  
112  
113  
114 =head2 AllowMajorVersionUpgrade => Bool
115  
116 A value that indicates whether major version upgrades are allowed.
117 Changing this parameter doesn't result in an outage and the change is
118 asynchronously applied as soon as possible.
119  
120 Constraints: Major version upgrades must be allowed when specifying a
121 value for the EngineVersion parameter that is a different major version
122 than the DB instance's current version.
123  
124  
125  
126 =head2 ApplyImmediately => Bool
127  
128 A value that indicates whether the modifications in this request and
129 any pending modifications are asynchronously applied as soon as
130 possible, regardless of the C<PreferredMaintenanceWindow> setting for
131 the DB instance. By default, this parameter is disabled.
132  
133 If this parameter is disabled, changes to the DB instance are applied
134 during the next maintenance window. Some parameter changes can cause an
135 outage and are applied on the next call to RebootDBInstance, or the
136 next failure reboot. Review the table of parameters in Modifying a DB
137 Instance
138 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
139 in the I<Amazon RDS User Guide.> to see the impact of enabling or
140 disabling C<ApplyImmediately> for each modified parameter and to
141 determine when the changes are applied.
142  
143  
144  
145 =head2 AutoMinorVersionUpgrade => Bool
146  
147 A value that indicates whether minor version upgrades are applied
148 automatically to the DB instance during the maintenance window.
149 Changing this parameter doesn't result in an outage except in the
150 following case and the change is asynchronously applied as soon as
151 possible. An outage results if this parameter is enabled during the
152 maintenance window, and a newer minor version is available, and RDS has
153 enabled auto patching for that engine version.
154  
155  
156  
157 =head2 AwsBackupRecoveryPointArn => Str
158  
159 The Amazon Resource Name (ARN) of the recovery point in Amazon Web
160 Services Backup.
161  
162  
163  
164 =head2 BackupRetentionPeriod => Int
165  
166 The number of days to retain automated backups. Setting this parameter
167 to a positive number enables backups. Setting this parameter to 0
168 disables automated backups.
169  
170 Enabling and disabling backups can result in a brief I/O suspension
171 that lasts from a few seconds to a few minutes, depending on the size
172 and class of your DB instance.
173  
174 These changes are applied during the next maintenance window unless the
175 C<ApplyImmediately> parameter is enabled for this request. If you
176 change the parameter from one non-zero value to another non-zero value,
177 the change is asynchronously applied as soon as possible.
178  
179 B<Amazon Aurora>
180  
181 Not applicable. The retention period for automated backups is managed
182 by the DB cluster. For more information, see C<ModifyDBCluster>.
183  
184 Default: Uses existing setting
185  
186 Constraints:
187  
188 =over
189  
190 =item *
191  
192 Must be a value from 0 to 35
193  
194 =item *
195  
196 Can be specified for a MySQL read replica only if the source is running
197 MySQL 5.6 or later
198  
199 =item *
200  
201 Can be specified for a PostgreSQL read replica only if the source is
202 running PostgreSQL 9.3.5
203  
204 =item *
205  
206 Can't be set to 0 if the DB instance is a source to read replicas
207  
208 =back
209  
210  
211  
212  
213 =head2 CACertificateIdentifier => Str
214  
215 Indicates the certificate that needs to be associated with the
216 instance.
217  
218  
219  
220 =head2 CertificateRotationRestart => Bool
221  
222 A value that indicates whether the DB instance is restarted when you
223 rotate your SSL/TLS certificate.
224  
225 By default, the DB instance is restarted when you rotate your SSL/TLS
226 certificate. The certificate is not updated until the DB instance is
227 restarted.
228  
229 Set this parameter only if you are I<not> using SSL/TLS to connect to
230 the DB instance.
231  
232 If you are using SSL/TLS to connect to the DB instance, follow the
233 appropriate instructions for your DB engine to rotate your SSL/TLS
234 certificate:
235  
236 =over
237  
238 =item *
239  
240 For more information about rotating your SSL/TLS certificate for RDS DB
241 engines, see Rotating Your SSL/TLS Certificate.
242 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html)
243 in the I<Amazon RDS User Guide.>
244  
245 =item *
246  
247 For more information about rotating your SSL/TLS certificate for Aurora
248 DB engines, see Rotating Your SSL/TLS Certificate
249 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html)
250 in the I<Amazon Aurora User Guide.>
251  
252 =back
253  
254  
255  
256  
257 =head2 CloudwatchLogsExportConfiguration => L<Paws::RDS::CloudwatchLogsExportConfiguration>
258  
259 The configuration setting for the log types to be enabled for export to
260 CloudWatch Logs for a specific DB instance.
261  
262 A change to the C<CloudwatchLogsExportConfiguration> parameter is
263 always applied to the DB instance immediately. Therefore, the
264 C<ApplyImmediately> parameter has no effect.
265  
266  
267  
268 =head2 CopyTagsToSnapshot => Bool
269  
270 A value that indicates whether to copy all tags from the DB instance to
271 snapshots of the DB instance. By default, tags are not copied.
272  
273 B<Amazon Aurora>
274  
275 Not applicable. Copying tags to snapshots is managed by the DB cluster.
276 Setting this value for an Aurora DB instance has no effect on the DB
277 cluster setting. For more information, see C<ModifyDBCluster>.
278  
279  
280  
281 =head2 DBInstanceClass => Str
282  
283 The new compute and memory capacity of the DB instance, for example,
284 C<db.m4.large>. Not all DB instance classes are available in all Amazon
285 Web Services Regions, or for all database engines. For the full list of
286 DB instance classes, and availability for your engine, see DB Instance
287 Class
288 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
289 in the I<Amazon RDS User Guide.>
290  
291 If you modify the DB instance class, an outage occurs during the
292 change. The change is applied during the next maintenance window,
293 unless C<ApplyImmediately> is enabled for this request.
294  
295 Default: Uses existing setting
296  
297  
298  
299 =head2 B<REQUIRED> DBInstanceIdentifier => Str
300  
301 The DB instance identifier. This value is stored as a lowercase string.
302  
303 Constraints:
304  
305 =over
306  
307 =item *
308  
309 Must match the identifier of an existing DBInstance.
310  
311 =back
312  
313  
314  
315  
316 =head2 DBParameterGroupName => Str
317  
318 The name of the DB parameter group to apply to the DB instance.
319 Changing this setting doesn't result in an outage. The parameter group
320 name itself is changed immediately, but the actual parameter changes
321 are not applied until you reboot the instance without failover. In this
322 case, the DB instance isn't rebooted automatically and the parameter
323 changes isn't applied during the next maintenance window.
324  
325 Default: Uses existing setting
326  
327 Constraints: The DB parameter group must be in the same DB parameter
328 group family as this DB instance.
329  
330  
331  
332 =head2 DBPortNumber => Int
333  
334 The port number on which the database accepts connections.
335  
336 The value of the C<DBPortNumber> parameter must not match any of the
337 port values specified for options in the option group for the DB
338 instance.
339  
340 Your database will restart when you change the C<DBPortNumber> value
341 regardless of the value of the C<ApplyImmediately> parameter.
342  
343 B<MySQL>
344  
345 Default: C<3306>
346  
347 Valid values: C<1150-65535>
348  
349 B<MariaDB>
350  
351 Default: C<3306>
352  
353 Valid values: C<1150-65535>
354  
355 B<PostgreSQL>
356  
357 Default: C<5432>
358  
359 Valid values: C<1150-65535>
360  
361 Type: Integer
362  
363 B<Oracle>
364  
365 Default: C<1521>
366  
367 Valid values: C<1150-65535>
368  
369 B<SQL Server>
370  
371 Default: C<1433>
372  
373 Valid values: C<1150-65535> except C<1234>, C<1434>, C<3260>, C<3343>,
374 C<3389>, C<47001>, and C<49152-49156>.
375  
376 B<Amazon Aurora>
377  
378 Default: C<3306>
379  
380 Valid values: C<1150-65535>
381  
382  
383  
384 =head2 DBSecurityGroups => ArrayRef[Str|Undef]
385  
386 A list of DB security groups to authorize on this DB instance. Changing
387 this setting doesn't result in an outage and the change is
388 asynchronously applied as soon as possible.
389  
390 Constraints:
391  
392 =over
393  
394 =item *
395  
396 If supplied, must match existing DBSecurityGroups.
397  
398 =back
399  
400  
401  
402  
403 =head2 DBSubnetGroupName => Str
404  
405 The new DB subnet group for the DB instance. You can use this parameter
406 to move your DB instance to a different VPC. If your DB instance isn't
407 in a VPC, you can also use this parameter to move your DB instance into
408 a VPC. For more information, see Working with a DB instance in a VPC
409 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC)
410 in the I<Amazon RDS User Guide.>
411  
412 Changing the subnet group causes an outage during the change. The
413 change is applied during the next maintenance window, unless you enable
414 C<ApplyImmediately>.
415  
416 Constraints: If supplied, must match the name of an existing
417 DBSubnetGroup.
418  
419 Example: C<mySubnetGroup>
420  
421  
422  
423 =head2 DeletionProtection => Bool
424  
425 A value that indicates whether the DB instance has deletion protection
426 enabled. The database can't be deleted when deletion protection is
427 enabled. By default, deletion protection is disabled. For more
428 information, see Deleting a DB Instance
429 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
430  
431  
432  
433 =head2 Domain => Str
434  
435 The Active Directory directory ID to move the DB instance to. Specify
436 C<none> to remove the instance from its current domain. The domain must
437 be created prior to this operation. Currently, only MySQL, Microsoft
438 SQL Server, Oracle, and PostgreSQL DB instances can be created in an
439 Active Directory Domain.
440  
441 For more information, see Kerberos Authentication
442 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
443 in the I<Amazon RDS User Guide>.
444  
445  
446  
447 =head2 DomainIAMRoleName => Str
448  
449 The name of the IAM role to use when making API calls to the Directory
450 Service.
451  
452  
453  
454 =head2 EnableCustomerOwnedIp => Bool
455  
456 A value that indicates whether to enable a customer-owned IP address
457 (CoIP) for an RDS on Outposts DB instance.
458  
459 A I<CoIP> provides local or external connectivity to resources in your
460 Outpost subnets through your on-premises network. For some use cases, a
461 CoIP can provide lower latency for connections to the DB instance from
462 outside of its virtual private cloud (VPC) on your local network.
463  
464 For more information about RDS on Outposts, see Working with Amazon RDS
465 on Amazon Web Services Outposts
466 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
467 in the I<Amazon RDS User Guide>.
468  
469 For more information about CoIPs, see Customer-owned IP addresses
470 (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
471 in the I<Amazon Web Services Outposts User Guide>.
472  
473  
474  
475 =head2 EnableIAMDatabaseAuthentication => Bool
476  
477 A value that indicates whether to enable mapping of Amazon Web Services
478 Identity and Access Management (IAM) accounts to database accounts. By
479 default, mapping is disabled.
480  
481 This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
482 Services IAM accounts to database accounts is managed by the DB
483 cluster.
484  
485 For more information about IAM database authentication, see IAM
486 Database Authentication for MySQL and PostgreSQL
487 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
488 in the I<Amazon RDS User Guide.>
489  
490  
491  
492 =head2 EnablePerformanceInsights => Bool
493  
494 A value that indicates whether to enable Performance Insights for the
495 DB instance.
496  
497 For more information, see Using Amazon Performance Insights
498 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
499 in the I<Amazon Relational Database Service User Guide>.
500  
501  
502  
503 =head2 EngineVersion => Str
504  
505 The version number of the database engine to upgrade to. Changing this
506 parameter results in an outage and the change is applied during the
507 next maintenance window unless the C<ApplyImmediately> parameter is
508 enabled for this request.
509  
510 For major version upgrades, if a nondefault DB parameter group is
511 currently in use, a new DB parameter group in the DB parameter group
512 family for the new engine version must be specified. The new DB
513 parameter group can be the default for that DB parameter group family.
514  
515 If you specify only a major version, Amazon RDS will update the DB
516 instance to the default minor version if the current minor version is
517 lower. For information about valid engine versions, see
518 C<CreateDBInstance>, or call C<DescribeDBEngineVersions>.
519  
520  
521  
522 =head2 Iops => Int
523  
524 The new Provisioned IOPS (I/O operations per second) value for the RDS
525 instance.
526  
527 Changing this setting doesn't result in an outage and the change is
528 applied during the next maintenance window unless the
529 C<ApplyImmediately> parameter is enabled for this request. If you are
530 migrating from Provisioned IOPS to standard storage, set this value to
531 0. The DB instance will require a reboot for the change in storage type
532 to take effect.
533  
534 If you choose to migrate your DB instance from using standard storage
535 to using Provisioned IOPS, or from using Provisioned IOPS to using
536 standard storage, the process can take time. The duration of the
537 migration depends on several factors such as database load, storage
538 size, storage type (standard or Provisioned IOPS), amount of IOPS
539 provisioned (if any), and the number of prior scale storage operations.
540 Typical migration times are under 24 hours, but the process can take up
541 to several days in some cases. During the migration, the DB instance is
542 available for use, but might experience performance degradation. While
543 the migration takes place, nightly backups for the instance are
544 suspended. No other Amazon RDS operations can take place for the
545 instance, including modifying the instance, rebooting the instance,
546 deleting the instance, creating a read replica for the instance, and
547 creating a DB snapshot of the instance.
548  
549 Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
550 supplied must be at least 10% greater than the current value. Values
551 that are not at least 10% greater than the existing value are rounded
552 up so that they are 10% greater than the current value.
553  
554 Default: Uses existing setting
555  
556  
557  
558 =head2 LicenseModel => Str
559  
560 The license model for the DB instance.
561  
562 Valid values: C<license-included> | C<bring-your-own-license> |
563 C<general-public-license>
564  
565  
566  
567 =head2 MasterUserPassword => Str
568  
569 The new password for the master user. The password can include any
570 printable ASCII character except "/", """, or "@".
571  
572 Changing this parameter doesn't result in an outage and the change is
573 asynchronously applied as soon as possible. Between the time of the
574 request and the completion of the request, the C<MasterUserPassword>
575 element exists in the C<PendingModifiedValues> element of the operation
576 response.
577  
578 B<Amazon Aurora>
579  
580 Not applicable. The password for the master user is managed by the DB
581 cluster. For more information, see C<ModifyDBCluster>.
582  
583 Default: Uses existing setting
584  
585 B<MariaDB>
586  
587 Constraints: Must contain from 8 to 41 characters.
588  
589 B<Microsoft SQL Server>
590  
591 Constraints: Must contain from 8 to 128 characters.
592  
593 B<MySQL>
594  
595 Constraints: Must contain from 8 to 41 characters.
596  
597 B<Oracle>
598  
599 Constraints: Must contain from 8 to 30 characters.
600  
601 B<PostgreSQL>
602  
603 Constraints: Must contain from 8 to 128 characters.
604  
605 Amazon RDS API actions never return the password, so this action
606 provides a way to regain access to a primary instance user if the
607 password is lost. This includes restoring privileges that might have
608 been accidentally revoked.
609  
610  
611  
612 =head2 MaxAllocatedStorage => Int
613  
614 The upper limit to which Amazon RDS can automatically scale the storage
615 of the DB instance.
616  
617 For more information about this setting, including limitations that
618 apply to it, see Managing capacity automatically with Amazon RDS
619 storage autoscaling
620 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
621 in the I<Amazon RDS User Guide>.
622  
623  
624  
625 =head2 MonitoringInterval => Int
626  
627 The interval, in seconds, between points when Enhanced Monitoring
628 metrics are collected for the DB instance. To disable collecting
629 Enhanced Monitoring metrics, specify 0. The default is 0.
630  
631 If C<MonitoringRoleArn> is specified, then you must also set
632 C<MonitoringInterval> to a value other than 0.
633  
634 Valid Values: C<0, 1, 5, 10, 15, 30, 60>
635  
636  
637  
638 =head2 MonitoringRoleArn => Str
639  
640 The ARN for the IAM role that permits RDS to send enhanced monitoring
641 metrics to Amazon CloudWatch Logs. For example,
642 C<arn:aws:iam:123456789012:role/emaccess>. For information on creating
643 a monitoring role, go to To create an IAM role for Amazon RDS Enhanced
644 Monitoring
645 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole)
646 in the I<Amazon RDS User Guide.>
647  
648 If C<MonitoringInterval> is set to a value other than 0, then you must
649 supply a C<MonitoringRoleArn> value.
650  
651  
652  
653 =head2 MultiAZ => Bool
654  
655 A value that indicates whether the DB instance is a Multi-AZ
656 deployment. Changing this parameter doesn't result in an outage and the
657 change is applied during the next maintenance window unless the
658 C<ApplyImmediately> parameter is enabled for this request.
659  
660  
661  
662 =head2 NewDBInstanceIdentifier => Str
663  
664 The new DB instance identifier for the DB instance when renaming a DB
665 instance. When you change the DB instance identifier, an instance
666 reboot occurs immediately if you enable C<ApplyImmediately>, or will
667 occur during the next maintenance window if you disable Apply
668 Immediately. This value is stored as a lowercase string.
669  
670 Constraints:
671  
672 =over
673  
674 =item *
675  
676 Must contain from 1 to 63 letters, numbers, or hyphens.
677  
678 =item *
679  
680 The first character must be a letter.
681  
682 =item *
683  
684 Can't end with a hyphen or contain two consecutive hyphens.
685  
686 =back
687  
688 Example: C<mydbinstance>
689  
690  
691  
692 =head2 OptionGroupName => Str
693  
694 A value that indicates the DB instance should be associated with the
695 specified option group. Changing this parameter doesn't result in an
696 outage except in the following case and the change is applied during
697 the next maintenance window unless the C<ApplyImmediately> parameter is
698 enabled for this request. If the parameter change results in an option
699 group that enables OEM, this change can cause a brief (sub-second)
700 period during which new connections are rejected but existing
701 connections are not interrupted.
702  
703 Permanent options, such as the TDE option for Oracle Advanced Security
704 TDE, can't be removed from an option group, and that option group can't
705 be removed from a DB instance once it is associated with a DB instance
706  
707  
708  
709 =head2 PerformanceInsightsKMSKeyId => Str
710  
711 The Amazon Web Services KMS key identifier for encryption of
712 Performance Insights data.
713  
714 The Amazon Web Services KMS key identifier is the key ARN, key ID,
715 alias ARN, or alias name for the Amazon Web Services KMS customer
716 master key (CMK).
717  
718 If you do not specify a value for C<PerformanceInsightsKMSKeyId>, then
719 Amazon RDS uses your default CMK. There is a default CMK for your
720 Amazon Web Services account. Your Amazon Web Services account has a
721 different default CMK for each Amazon Web Services Region.
722  
723  
724  
725 =head2 PerformanceInsightsRetentionPeriod => Int
726  
727 The amount of time, in days, to retain Performance Insights data. Valid
728 values are 7 or 731 (2 years).
729  
730  
731  
732 =head2 PreferredBackupWindow => Str
733  
734 The daily time range during which automated backups are created if
735 automated backups are enabled, as determined by the
736 C<BackupRetentionPeriod> parameter. Changing this parameter doesn't
737 result in an outage and the change is asynchronously applied as soon as
738 possible. The default is a 30-minute window selected at random from an
739 8-hour block of time for each Amazon Web Services Region. For more
740 information, see Backup window
741 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
742 in the I<Amazon RDS User Guide.>
743  
744 B<Amazon Aurora>
745  
746 Not applicable. The daily time range for creating automated backups is
747 managed by the DB cluster. For more information, see
748 C<ModifyDBCluster>.
749  
750 Constraints:
751  
752 =over
753  
754 =item *
755  
756 Must be in the format hh24:mi-hh24:mi
757  
758 =item *
759  
760 Must be in Universal Time Coordinated (UTC)
761  
762 =item *
763  
764 Must not conflict with the preferred maintenance window
765  
766 =item *
767  
768 Must be at least 30 minutes
769  
770 =back
771  
772  
773  
774  
775 =head2 PreferredMaintenanceWindow => Str
776  
777 The weekly time range (in UTC) during which system maintenance can
778 occur, which might result in an outage. Changing this parameter doesn't
779 result in an outage, except in the following situation, and the change
780 is asynchronously applied as soon as possible. If there are pending
781 actions that cause a reboot, and the maintenance window is changed to
782 include the current time, then changing this parameter will cause a
783 reboot of the DB instance. If moving this window to the current time,
784 there must be at least 30 minutes between the current time and end of
785 the window to ensure pending changes are applied.
786  
787 For more information, see Amazon RDS Maintenance Window
788 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)
789 in the I<Amazon RDS User Guide.>
790  
791 Default: Uses existing setting
792  
793 Format: ddd:hh24:mi-ddd:hh24:mi
794  
795 Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
796  
797 Constraints: Must be at least 30 minutes
798  
799  
800  
801 =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>]
802  
803 The number of CPU cores and the number of threads per core for the DB
804 instance class of the DB instance.
805  
806  
807  
808 =head2 PromotionTier => Int
809  
810 A value that specifies the order in which an Aurora Replica is promoted
811 to the primary instance after a failure of the existing primary
812 instance. For more information, see Fault Tolerance for an Aurora DB
813 Cluster
814 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance)
815 in the I<Amazon Aurora User Guide>.
816  
817 Default: 1
818  
819 Valid Values: 0 - 15
820  
821  
822  
823 =head2 PubliclyAccessible => Bool
824  
825 A value that indicates whether the DB instance is publicly accessible.
826  
827 When the DB instance is publicly accessible, its DNS endpoint resolves
828 to the private IP address from within the DB instance's VPC, and to the
829 public IP address from outside of the DB instance's VPC. Access to the
830 DB instance is ultimately controlled by the security group it uses, and
831 that public access is not permitted if the security group assigned to
832 the DB instance doesn't permit it.
833  
834 When the DB instance isn't publicly accessible, it is an internal DB
835 instance with a DNS name that resolves to a private IP address.
836  
837 C<PubliclyAccessible> only applies to DB instances in a VPC. The DB
838 instance must be part of a public subnet and C<PubliclyAccessible> must
839 be enabled for it to be publicly accessible.
840  
841 Changes to the C<PubliclyAccessible> parameter are applied immediately
842 regardless of the value of the C<ApplyImmediately> parameter.
843  
844  
845  
846 =head2 ReplicaMode => Str
847  
848 A value that sets the open mode of a replica database to either mounted
849 or read-only.
850  
851 Currently, this parameter is only supported for Oracle DB instances.
852  
853 Mounted DB replicas are included in Oracle Enterprise Edition. The main
854 use case for mounted replicas is cross-Region disaster recovery. The
855 primary database doesn't use Active Data Guard to transmit information
856 to the mounted replica. Because it doesn't accept user connections, a
857 mounted replica can't serve a read-only workload. For more information,
858 see Working with Oracle Read Replicas for Amazon RDS
859 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
860 in the I<Amazon RDS User Guide>.
861  
862 Valid values are: C<"open-read-only">, C<"mounted">
863  
864 =head2 StorageType => Str
865  
866 Specifies the storage type to be associated with the DB instance.
867  
868 If you specify Provisioned IOPS (C<io1>), you must also include a value
869 for the C<Iops> parameter.
870  
871 If you choose to migrate your DB instance from using standard storage
872 to using Provisioned IOPS, or from using Provisioned IOPS to using
873 standard storage, the process can take time. The duration of the
874 migration depends on several factors such as database load, storage
875 size, storage type (standard or Provisioned IOPS), amount of IOPS
876 provisioned (if any), and the number of prior scale storage operations.
877 Typical migration times are under 24 hours, but the process can take up
878 to several days in some cases. During the migration, the DB instance is
879 available for use, but might experience performance degradation. While
880 the migration takes place, nightly backups for the instance are
881 suspended. No other Amazon RDS operations can take place for the
882 instance, including modifying the instance, rebooting the instance,
883 deleting the instance, creating a read replica for the instance, and
884 creating a DB snapshot of the instance.
885  
886 Valid values: C<standard | gp2 | io1>
887  
888 Default: C<io1> if the C<Iops> parameter is specified, otherwise C<gp2>
889  
890  
891  
892 =head2 TdeCredentialArn => Str
893  
894 The ARN from the key store with which to associate the instance for TDE
895 encryption.
896  
897  
898  
899 =head2 TdeCredentialPassword => Str
900  
901 The password for the given ARN from the key store in order to access
902 the device.
903  
904  
905  
906 =head2 UseDefaultProcessorFeatures => Bool
907  
908 A value that indicates whether the DB instance class of the DB instance
909 uses its default processor features.
910  
911  
912  
913 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
914  
915 A list of EC2 VPC security groups to authorize on this DB instance.
916 This change is asynchronously applied as soon as possible.
917  
918 B<Amazon Aurora>
919  
920 Not applicable. The associated list of EC2 VPC security groups is
921 managed by the DB cluster. For more information, see
922 C<ModifyDBCluster>.
923  
924 Constraints:
925  
926 =over
927  
928 =item *
929  
930 If supplied, must match existing VpcSecurityGroupIds.
931  
932 =back
933  
934  
935  
936  
937  
938 =head1 SEE ALSO
939  
940 This class forms part of L<Paws>, documenting arguments for method ModifyDBInstance in L<Paws::RDS>
941  
942 =head1 BUGS and CONTRIBUTIONS
943  
944 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
945  
946 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
947  
948 =cut
949