Struct aws_sdk_docdb::client::fluent_builders::ModifyDBInstance

pub struct ModifyDBInstance { /* private fields */ }

Fluent builder constructing a request to 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.

Implementations

impl ModifyDBInstance

pub async fn send(
    self
) -> Result<ModifyDbInstanceOutput, SdkError<ModifyDBInstanceError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn db_instance_identifier(self, input: impl Into<String>) -> Self

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

Constraints:

• Must match the identifier of an existing DBInstance.

pub fn set_db_instance_identifier(self, input: Option<String>) -> Self

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

Constraints:

• Must match the identifier of an existing DBInstance.

pub fn db_instance_class(self, input: impl Into<String>) -> Self

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.

pub fn set_db_instance_class(self, input: Option<String>) -> Self

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.

pub fn apply_immediately(self, input: bool) -> Self

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

pub fn set_apply_immediately(self, input: Option<bool>) -> Self

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

pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self

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.

pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self

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.

pub fn auto_minor_version_upgrade(self, input: bool) -> Self

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

pub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self

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

pub fn new_db_instance_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_new_db_instance_identifier(self, input: Option<String>) -> Self

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

pub fn ca_certificate_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_ca_certificate_identifier(self, input: Option<String>) -> Self

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

pub fn promotion_tier(self, input: i32) -> Self

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

pub fn set_promotion_tier(self, input: Option<i32>) -> Self

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 ModifyDBInstance

fn clone(&self) -> ModifyDBInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyDBInstance

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

Formats the value using the given formatter.