Struct aws_sdk_rds::input::ModifyDbClusterInput

source · [−]

#[non_exhaustive]
pub struct ModifyDbClusterInput {Show 34 fields
    pub db_cluster_identifier: Option<String>,
    pub new_db_cluster_identifier: Option<String>,
    pub apply_immediately: 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 option_group_name: Option<String>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub enable_iam_database_authentication: Option<bool>,
    pub backtrack_window: Option<i64>,
    pub cloudwatch_logs_export_configuration: Option<CloudwatchLogsExportConfiguration>,
    pub engine_version: Option<String>,
    pub allow_major_version_upgrade: bool,
    pub db_instance_parameter_group_name: Option<String>,
    pub domain: Option<String>,
    pub domain_iam_role_name: Option<String>,
    pub scaling_configuration: Option<ScalingConfiguration>,
    pub deletion_protection: Option<bool>,
    pub enable_http_endpoint: Option<bool>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub enable_global_write_forwarding: Option<bool>,
    pub db_cluster_instance_class: Option<String>,
    pub allocated_storage: Option<i32>,
    pub storage_type: Option<String>,
    pub iops: Option<i32>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub monitoring_interval: Option<i32>,
    pub monitoring_role_arn: Option<String>,
    pub enable_performance_insights: Option<bool>,
    pub performance_insights_kms_key_id: Option<String>,
    pub performance_insights_retention_period: Option<i32>,
}

Expand description

Fields (Non-exhaustive)

This struct is marked as 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 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

Valid for: Aurora DB clusters only

apply_immediately: 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

backup_retention_period: Option<i32>

The number of days for which automated backups are retained. Specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

db_cluster_parameter_group_name: Option<String>

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

vpc_security_group_ids: Option<Vec<String>>

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

port: Option<i32>

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.

Valid for: Aurora DB clusters only

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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

option_group_name: Option<String>

A value that indicates that the DB cluster should be associated with the specified option group.

DB clusters are associated with a default option group that can't be modified.

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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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 isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

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).

Valid for: Aurora MySQL DB clusters only

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.

Valid for: Aurora DB clusters only

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 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 MySQL 5.7-compatible and MySQL 8.0-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"

To list all of the available engine versions for RDS for MySQL, use the following command:

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

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

allow_major_version_upgrade: 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.

Valid for: Aurora DB clusters only

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 are applied immediately rather than during the next maintenance window.

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 valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.

Valid for: Aurora DB clusters only

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.

Valid for: Aurora DB clusters only

domain_iam_role_name: Option<String>

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

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.

Valid for: Aurora DB clusters only

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 isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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.

Valid for: Aurora DB clusters only

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.

Valid for: Aurora DB clusters only

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.

Valid for: Aurora DB clusters only

db_cluster_instance_class: Option<String>

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

allocated_storage: Option<i32>

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Type: Integer

Valid for: Multi-AZ DB clusters only

storage_type: Option<String>

Specifies the storage type to be associated with the DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

iops: Option<i32>

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

Valid for: Multi-AZ DB clusters only

auto_minor_version_upgrade: Option<bool>

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Valid for: Multi-AZ DB clusters only

monitoring_interval: Option<i32>

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Valid for: Multi-AZ DB clusters only

monitoring_role_arn: Option<String>

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

Valid for: Multi-AZ DB clusters only

enable_performance_insights: Option<bool>

A value that indicates whether to turn on Performance Insights for the DB cluster.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

performance_insights_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.

Valid for: Multi-AZ DB clusters only

performance_insights_retention_period: Option<i32>

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Valid for: Multi-AZ DB clusters only

Struct aws_sdk_rds::input::ModifyDbClusterInput

Fields (Non-exhaustive)

Implementations

impl ModifyDbClusterInput

pub async fn make_operation( &self, _config: &Config) -> Result<Operation<ModifyDBCluster, AwsErrorRetryPolicy>, BuildError>

pub fn builder() -> Builder

impl ModifyDbClusterInput

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

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

pub fn apply_immediately(&self) -> bool

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

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

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

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

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

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

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

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

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

pub fn backtrack_window(&self) -> Option<i64>

pub fn cloudwatch_logs_export_configuration( &self) -> Option<&CloudwatchLogsExportConfiguration>

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

pub fn allow_major_version_upgrade(&self) -> bool

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

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

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

pub fn scaling_configuration(&self) -> Option<&ScalingConfiguration>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for ModifyDbClusterInput

fn clone(&self) -> ModifyDbClusterInput

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

impl Debug for ModifyDbClusterInput

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

impl PartialEq<ModifyDbClusterInput> for ModifyDbClusterInput

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

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

impl StructuralPartialEq for ModifyDbClusterInput

Auto Trait Implementations

impl RefUnwindSafe for ModifyDbClusterInput

impl Send for ModifyDbClusterInput

impl Sync for ModifyDbClusterInput

impl Unpin for ModifyDbClusterInput

impl UnwindSafe for ModifyDbClusterInput

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<ModifyDBCluster, AwsErrorRetryPolicy>, BuildError>

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

pub fn cloudwatch_logs_export_configuration(
&self
) -> Option<&CloudwatchLogsExportConfiguration>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,