aws_sdk_rds/client/

modify_global_cluster.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyGlobalCluster`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`global_cluster_identifier(impl Into<String>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::global_cluster_identifier) / [`set_global_cluster_identifier(Option<String>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::set_global_cluster_identifier):<br>required: **false**<br><p>The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match the identifier of an existing global database cluster.</p></li> </ul><br>
    ///   - [`new_global_cluster_identifier(impl Into<String>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::new_global_cluster_identifier) / [`set_new_global_cluster_identifier(Option<String>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::set_new_global_cluster_identifier):<br>required: **false**<br><p>The new cluster identifier for the global database cluster. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul>  <li>   <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>  <li>   <p>The first character must be a letter.</p></li>  <li>   <p>Can't end with a hyphen or contain two consecutive hyphens.</p></li> </ul> <p>Example: <code>my-cluster2</code></p><br>
    ///   - [`deletion_protection(bool)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::deletion_protection) / [`set_deletion_protection(Option<bool>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::set_deletion_protection):<br>required: **false**<br><p>Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.</p><br>
    ///   - [`engine_version(impl Into<String>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::set_engine_version):<br>required: **false**<br><p>The version number of the database engine to which you want to upgrade.</p> <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL-based Aurora global databases), use the following command:</p> <p><code>aws rds describe-db-engine-versions --engine aurora-mysql --query '*\[\]|\[?SupportsGlobalDatabases == `true`\].\[EngineVersion\]'</code></p> <p>To list all of the available engine versions for <code>aurora-postgresql</code> (for PostgreSQL-based Aurora global databases), use the following command:</p> <p><code>aws rds describe-db-engine-versions --engine aurora-postgresql --query '*\[\]|\[?SupportsGlobalDatabases == `true`\].\[EngineVersion\]'</code></p><br>
    ///   - [`allow_major_version_upgrade(bool)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::allow_major_version_upgrade) / [`set_allow_major_version_upgrade(Option<bool>)`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::set_allow_major_version_upgrade):<br>required: **false**<br><p>Specifies whether to allow major version upgrades.</p> <p>Constraints: Must be enabled if you specify a value for the <code>EngineVersion</code> parameter that's a different major version than the global cluster's current version.</p> <p>If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.</p><br>
    /// - On success, responds with [`ModifyGlobalClusterOutput`](crate::operation::modify_global_cluster::ModifyGlobalClusterOutput) with field(s):
    ///   - [`global_cluster(Option<GlobalCluster>)`](crate::operation::modify_global_cluster::ModifyGlobalClusterOutput::global_cluster): <p>A data type representing an Aurora global database.</p>
    /// - On failure, responds with [`SdkError<ModifyGlobalClusterError>`](crate::operation::modify_global_cluster::ModifyGlobalClusterError)
    pub fn modify_global_cluster(&self) -> crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder {
        crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::new(self.handle.clone())
    }
}