Struct rusoto_docdb::ModifyDBInstanceMessage

pub struct ModifyDBInstanceMessage {
    pub apply_immediately: Option<bool>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub ca_certificate_identifier: Option<String>,
    pub db_instance_class: Option<String>,
    pub db_instance_identifier: String,
    pub new_db_instance_identifier: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub promotion_tier: Option<i64>,
}

Represents the input to ModifyDBInstance.

Fields

apply_immediately: Option<bool>

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting 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

auto_minor_version_upgrade: Option<bool>

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

ca_certificate_identifier: Option<String>

Indicates the certificate that needs to be associated with the instance.

db_instance_class: Option<String>

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

db_instance_identifier: String

The instance identifier. This value is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBInstance.

new_db_instance_identifier: Option<String>

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 Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. 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

preferred_maintenance_window: Option<String>

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:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

promotion_tier: Option<i64>

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

Trait Implementations

impl Clone for ModifyDBInstanceMessage

fn clone(&self) -> ModifyDBInstanceMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModifyDBInstanceMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModifyDBInstanceMessage

fn default() -> ModifyDBInstanceMessage

Returns the “default value” for a type.

impl PartialEq<ModifyDBInstanceMessage> for ModifyDBInstanceMessage

fn eq(&self, other: &ModifyDBInstanceMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ModifyDBInstanceMessage) -> bool

This method tests for !=.

impl StructuralPartialEq for ModifyDBInstanceMessage