Struct aws_sdk_docdb::client::fluent_builders::ModifyDBCluster

pub struct ModifyDBCluster { /* private fields */ }

Fluent builder constructing a request to ModifyDBCluster.

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Implementations

impl ModifyDBCluster

pub async fn send(
    self
) -> Result<ModifyDbClusterOutput, SdkError<ModifyDBClusterError>>

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_cluster_identifier(self, input: impl Into<String>) -> Self

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

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

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

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

The new cluster identifier for the cluster when renaming a cluster. 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: my-cluster2

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

The new cluster identifier for the cluster when renaming a cluster. 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: my-cluster2

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

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

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

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

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

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

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

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

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

The name of the cluster parameter group to use for the cluster.

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

The name of the cluster parameter group to use for the cluster.

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

Appends an item to VpcSecurityGroupIds.

To override the contents of this collection use set_vpc_security_group_ids.

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

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

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

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

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

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

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

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

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

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

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

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

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

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

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

pub fn cloudwatch_logs_export_configuration(
    self,
    input: CloudwatchLogsExportConfiguration
) -> Self

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

pub fn set_cloudwatch_logs_export_configuration(
    self,
    input: Option<CloudwatchLogsExportConfiguration>
) -> Self

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

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

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

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

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Trait Implementations

impl Clone for ModifyDBCluster

fn clone(&self) -> ModifyDBCluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyDBCluster

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

Formats the value using the given formatter.