/AWS1/CL_DOD=>MODIFYDBINSTANCE()¶
About ModifyDBInstance¶
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DBINSTANCEIDENTIFIER TYPE /AWS1/DODSTRING /AWS1/DODSTRING¶
The instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing
DBInstance.
Optional arguments:¶
IV_DBINSTANCECLASS TYPE /AWS1/DODSTRING /AWS1/DODSTRING¶
The new compute and memory capacity of the instance; for example,
db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless
ApplyImmediatelyis specified astruefor this request.Default: Uses existing setting.
IV_APPLYIMMEDIATELY TYPE /AWS1/DODBOOLEAN /AWS1/DODBOOLEAN¶
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindowsetting for the instance.If this parameter is set to
false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.Default:
false
IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/DODSTRING /AWS1/DODSTRING¶
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format:
ddd:hh24:mi-ddd:hh24:miValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
IV_AUTOMINORVERSIONUPGRADE TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL¶
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
IV_NEWDBINSTANCEIDENTIFIER TYPE /AWS1/DODSTRING /AWS1/DODSTRING¶
The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set
Apply Immediatelytotrue. It occurs during the next maintenance window if you setApply Immediatelytofalse. This value is stored as a lowercase string.Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
IV_CACERTIFICATEIDENTIFIER TYPE /AWS1/DODSTRING /AWS1/DODSTRING¶
Indicates the certificate that needs to be associated with the instance.
IV_COPYTAGSTOSNAPSHOT TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL¶
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
IV_PROMOTIONTIER TYPE /AWS1/DODINTEGEROPTIONAL /AWS1/DODINTEGEROPTIONAL¶
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
IV_ENABLEPERFORMANCEINSIGHTS TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL¶
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
IV_PERFORMANCEINSIGHTSKMSK00 TYPE /AWS1/DODSTRING /AWS1/DODSTRING¶
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
IV_CERTROTATIONRESTART TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL¶
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.