class Aws::DocDB::Types::ModifyDBInstanceMessage
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
@return [Integer]
Valid values: 0-15
Default: 1
existing primary instance.
replica is promoted to the primary instance after a failure of the
A value that specifies the order in which an Amazon DocumentDB
@!attribute [rw] promotion_tier
@return [String]
Example: ‘mydbinstance`
* Cannot end with a hyphen or contain two consecutive hyphens.
* The first character must be a letter.
* Must contain from 1 to 63 letters, numbers, or hyphens.
Constraints:
Immediately` to `false`. This value is stored as a lowercase string.
It occurs during the next maintenance window if you set `Apply
reboot occurs immediately if you set `Apply Immediately` to `true`.
DB instance. When you change the DB instance identifier, an instance
The new DB instance identifier for the DB instance when renaming a
@!attribute [rw] new_db_instance_identifier
@return [Boolean]
version.
Amazon DocumentDB has enabled automatic patching for that engine
maintenance window, and a newer minor version is available, and
outage results if this parameter is set to `true` during the
and the change is asynchronously applied as soon as possible. An
parameter doesn’t result in an outage except in the following case,
the DB instance during the maintenance window. Changing this
Indicates that minor version upgrades are applied automatically to
@!attribute [rw] auto_minor_version_upgrade
@return [String]
Constraints: Must be at least 30 minutes.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Format: ‘ddd:hh24:mi-ddd:hh24:mi`
Default: Uses existing setting.
are applied.
current time and end of the window to ensure that pending changes
the current time, there must be at least 30 minutes between the
causes a reboot of the DB instance. If you are moving this window to
is changed to include the current time, changing this parameter
are pending actions that cause a reboot, and the maintenance window
the change is asynchronously applied as soon as possible. If there
doesn’t result in an outage except in the following situation, and
occur, which might result in an outage. Changing this parameter
The weekly time range (in UTC) during which system maintenance can
@!attribute [rw] preferred_maintenance_window
@return [Boolean]
Default: ‘false`
can cause an outage and are applied on the next reboot.
applied during the next maintenance window. Some parameter changes
If this parameter is set to `false`, changes to the DB instance are
instance.
regardless of the `PreferredMaintenanceWindow` setting for the DB
modifications are asynchronously applied as soon as possible,
Specifies whether the modifications in this request and any pending
@!attribute [rw] apply_immediately
@return [String]
Default: Uses existing setting.
unless `ApplyImmediately` is specified as `true` for this request.
change. The change is applied during the next maintenance window,
If you modify the DB instance class, an outage occurs during the
Regions.
`db.r5.large`. Not all DB instance classes are available in all AWS
The new compute and memory capacity of the DB instance; for example,
@!attribute [rw] db_instance_class
@return [String]
^
* Must match the identifier of an existing `DBInstance`.
Constraints:
string.
The DB instance identifier. This value is stored as a lowercase
@!attribute [rw] db_instance_identifier
}
promotion_tier: 1,
new_db_instance_identifier: “String”,
auto_minor_version_upgrade: false,
preferred_maintenance_window: “String”,
apply_immediately: false,
db_instance_class: “String”,
db_instance_identifier: “String”, # required
{
data as a hash:
@note When making an API call, you may pass ModifyDBInstanceMessage
Represents the input to ModifyDBInstance.