aws_sdk_docdb/client/
modify_global_cluster.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ModifyGlobalCluster`](crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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: **true**<br><p>The identifier for the global cluster being modified. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match the identifier of an existing global cluster.</p></li> </ul><br>
7    ///   - [`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 identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.</p> <ul>  <li>   <p>Must contain from 1 to 63 letters, numbers, or hyphens</p>   <p>The first character must be a letter</p>   <p>Can't end with a hyphen or contain two consecutive hyphens</p></li> </ul> <p>Example: <code>my-cluster2</code></p><br>
8    ///   - [`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>Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.</p><br>
9    /// - On success, responds with [`ModifyGlobalClusterOutput`](crate::operation::modify_global_cluster::ModifyGlobalClusterOutput) with field(s):
10    ///   - [`global_cluster(Option<GlobalCluster>)`](crate::operation::modify_global_cluster::ModifyGlobalClusterOutput::global_cluster): <p>A data type representing an Amazon DocumentDB global cluster.</p>
11    /// - On failure, responds with [`SdkError<ModifyGlobalClusterError>`](crate::operation::modify_global_cluster::ModifyGlobalClusterError)
12    pub fn modify_global_cluster(&self) -> crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder {
13        crate::operation::modify_global_cluster::builders::ModifyGlobalClusterFluentBuilder::new(self.handle.clone())
14    }
15}