Struct rusoto_rds::ModifyDBClusterMessage
source · [−]pub struct ModifyDBClusterMessage {Show 24 fields
pub allow_major_version_upgrade: Option<bool>,
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 db_instance_parameter_group_name: Option<String>,
pub deletion_protection: Option<bool>,
pub domain: Option<String>,
pub domain_iam_role_name: Option<String>,
pub enable_global_write_forwarding: 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>>,
}
Expand description
Fields
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.
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.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
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.
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 isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
db_cluster_parameter_group_name: Option<String>
The name of the DB cluster parameter group to use for the DB cluster.
db_instance_parameter_group_name: Option<String>
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
Constraints:
-
The DB parameter group must be in the same DB parameter group family as this DB cluster.
-
The
DBInstanceParameterGroupName
parameter is only valid in combination with theAllowMajorVersionUpgrade
parameter.
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.
domain: Option<String>
The Active Directory directory ID to move the DB cluster to. Specify none
to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
domain_iam_role_name: Option<String>
Specify the name of the IAM role to be used when making API calls to the Directory Service.
enable_global_write_forwarding: Option<bool>
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
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 Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
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 aurora
(for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
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 Amazon Web Services Region. To view the time blocks available, see Backup 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 Amazon Web Services 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
sourceimpl Clone for ModifyDBClusterMessage
impl Clone for ModifyDBClusterMessage
sourcefn clone(&self) -> ModifyDBClusterMessage
fn clone(&self) -> ModifyDBClusterMessage
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ModifyDBClusterMessage
impl Debug for ModifyDBClusterMessage
sourceimpl Default for ModifyDBClusterMessage
impl Default for ModifyDBClusterMessage
sourcefn default() -> ModifyDBClusterMessage
fn default() -> ModifyDBClusterMessage
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ModifyDBClusterMessage> for ModifyDBClusterMessage
impl PartialEq<ModifyDBClusterMessage> for ModifyDBClusterMessage
sourcefn eq(&self, other: &ModifyDBClusterMessage) -> bool
fn eq(&self, other: &ModifyDBClusterMessage) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ModifyDBClusterMessage) -> bool
fn ne(&self, other: &ModifyDBClusterMessage) -> bool
This method tests for !=
.
impl StructuralPartialEq for ModifyDBClusterMessage
Auto Trait Implementations
impl RefUnwindSafe for ModifyDBClusterMessage
impl Send for ModifyDBClusterMessage
impl Sync for ModifyDBClusterMessage
impl Unpin for ModifyDBClusterMessage
impl UnwindSafe for ModifyDBClusterMessage
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more