Struct aws_sdk_docdb::operation::modify_db_cluster::ModifyDbClusterInput

#[non_exhaustive]
pub struct ModifyDbClusterInput {

    pub db_cluster_identifier: Option<String>,
    pub new_db_cluster_identifier: Option<String>,
    pub apply_immediately: Option<bool>,
    pub backup_retention_period: Option<i32>,
    pub db_cluster_parameter_group_name: Option<String>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub port: Option<i32>,
    pub master_user_password: Option<String>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub cloudwatch_logs_export_configuration: Option<CloudwatchLogsExportConfiguration>,
    pub engine_version: Option<String>,
    pub allow_major_version_upgrade: Option<bool>,
    pub deletion_protection: Option<bool>,
    pub storage_type: Option<String>,
}

Represents the input to ModifyDBCluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_cluster_identifier: Option<String>

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.

new_db_cluster_identifier: Option<String>

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

apply_immediately: Option<bool>

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

backup_retention_period: Option<i32>

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.

db_cluster_parameter_group_name: Option<String>

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

vpc_security_group_ids: Option<Vec<String>>

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

port: Option<i32>

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.

master_user_password: Option<String>

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.

preferred_backup_window: Option<String>

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 Amazon Web Services 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.

preferred_maintenance_window: Option<String>

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 Amazon Web Services Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

cloudwatch_logs_export_configuration: Option<CloudwatchLogsExportConfiguration>

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.

engine_version: Option<String>

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for Amazon DocumentDB use the following command:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

allow_major_version_upgrade: Option<bool>

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

deletion_protection: Option<bool>

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.

storage_type: Option<String>

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Implementations

impl ModifyDbClusterInput

pub fn db_cluster_identifier(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<bool>

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) -> Option<i32>

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) -> Option<&str>

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

pub fn vpc_security_group_ids(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_group_ids.is_none().

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

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) -> Option<&str>

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) -> Option<&str>

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 Amazon Web Services 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) -> Option<&str>

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 Amazon Web Services 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 ) -> Option<&CloudwatchLogsExportConfiguration>

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) -> Option<&str>

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for Amazon DocumentDB use the following command:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

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

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

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

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 storage_type(&self) -> Option<&str>

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

impl ModifyDbClusterInput

pub fn builder() -> ModifyDbClusterInputBuilder

Creates a new builder-style object to manufacture ModifyDbClusterInput.

Trait Implementations

impl Clone for ModifyDbClusterInput

fn clone(&self) -> ModifyDbClusterInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyDbClusterInput

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

Formats the value using the given formatter.

impl PartialEq for ModifyDbClusterInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ModifyDbClusterInput