Struct aws_sdk_docdb::operation::modify_db_instance::builders::ModifyDBInstanceFluentBuilder

pub struct ModifyDBInstanceFluentBuilder { /* 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 ModifyDBInstanceFluentBuilder

pub fn as_input(&self) -> &ModifyDbInstanceInputBuilder

Access the ModifyDBInstance as a reference.

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

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 customize( self ) -> CustomizableOperation<ModifyDbInstanceOutput, ModifyDBInstanceError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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 get_db_instance_identifier(&self) -> &Option<String>

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 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 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 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 ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

pub fn get_db_instance_class(&self) -> &Option<String>

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 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 get_apply_immediately(&self) -> &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

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 get_preferred_maintenance_window(&self) -> &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.

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 get_auto_minor_version_upgrade(&self) -> &Option<bool>

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 get_new_db_instance_identifier(&self) -> &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

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 get_ca_certificate_identifier(&self) -> &Option<String>

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

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

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.

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

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.

pub fn get_copy_tags_to_snapshot(&self) -> &Option<bool>

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.

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

pub fn get_promotion_tier(&self) -> &Option<i32>

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 enable_performance_insights(self, input: bool) -> Self

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

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

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

pub fn get_enable_performance_insights(&self) -> &Option<bool>

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

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

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.

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

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.

pub fn get_performance_insights_kms_key_id(&self) -> &Option<String>

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.

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

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.

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

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.

pub fn get_certificate_rotation_restart(&self) -> &Option<bool>

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.

Trait Implementations

impl Clone for ModifyDBInstanceFluentBuilder

fn clone(&self) -> ModifyDBInstanceFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyDBInstanceFluentBuilder

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

Formats the value using the given formatter.