Struct rusoto_rds::ModifyDBClusterMessage

pub struct ModifyDBClusterMessage {
    pub apply_immediately: Option<bool>,
    pub backtrack_window: Option<i64>,
    pub backup_retention_period: Option<i64>,
    pub cloudwatch_logs_export_configuration: Option<CloudwatchLogsExportConfiguration>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub db_cluster_identifier: String,
    pub db_cluster_parameter_group_name: Option<String>,
    pub deletion_protection: Option<bool>,
    pub enable_http_endpoint: Option<bool>,
    pub enable_iam_database_authentication: Option<bool>,
    pub engine_version: Option<String>,
    pub master_user_password: Option<String>,
    pub new_db_cluster_identifier: Option<String>,
    pub option_group_name: Option<String>,
    pub port: Option<i64>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub scaling_configuration: Option<ScalingConfiguration>,
    pub vpc_security_group_ids: Option<Vec<String>>,
}

Fields

apply_immediately: Option<bool>

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

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

backtrack_window: Option<i64>

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

backup_retention_period: Option<i64>

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

cloudwatch_logs_export_configuration: Option<CloudwatchLogsExportConfiguration>

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

copy_tags_to_snapshot: Option<bool>

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

db_cluster_identifier: String

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

Constraints:

• Must match the identifier of an existing DBCluster.

db_cluster_parameter_group_name: Option<String>

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

deletion_protection: Option<bool>

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enable_http_endpoint: Option<bool>

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

enable_iam_database_authentication: Option<bool>

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

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.

For a list of valid engine versions, use DescribeDBEngineVersions.

master_user_password: Option<String>

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

new_db_cluster_identifier: Option<String>

The new DB cluster identifier for the DB cluster when renaming a DB 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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

option_group_name: Option<String>

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

port: Option<i64>

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

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 AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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 AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

scaling_configuration: Option<ScalingConfiguration>

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

vpc_security_group_ids: Option<Vec<String>>

A list of VPC security groups that the DB cluster will belong to.

Trait Implementations

impl PartialEq<ModifyDBClusterMessage> for ModifyDBClusterMessage

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

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

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

This method tests for !=.

impl Default for ModifyDBClusterMessage

fn default() -> ModifyDBClusterMessage

Returns the "default value" for a type.

impl Clone for ModifyDBClusterMessage

fn clone(&self) -> ModifyDBClusterMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyDBClusterMessage

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

Formats the value using the given formatter.