aws_sdk_docdb/client/
create_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 [`CreateGlobalCluster`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`global_cluster_identifier(impl Into<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::global_cluster_identifier) / [`set_global_cluster_identifier(Option<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_global_cluster_identifier):<br>required: **true**<br><p>The cluster identifier of the new global cluster.</p><br>
7    ///   - [`source_db_cluster_identifier(impl Into<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::source_db_cluster_identifier) / [`set_source_db_cluster_identifier(Option<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_source_db_cluster_identifier):<br>required: **false**<br><p>The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.</p><br>
8    ///   - [`engine(impl Into<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_engine):<br>required: **false**<br><p>The name of the database engine to be used for this cluster.</p><br>
9    ///   - [`engine_version(impl Into<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_engine_version):<br>required: **false**<br><p>The engine version of the global cluster.</p><br>
10    ///   - [`deletion_protection(bool)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::deletion_protection) / [`set_deletion_protection(Option<bool>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_deletion_protection):<br>required: **false**<br><p>The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.</p><br>
11    ///   - [`database_name(impl Into<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_database_name):<br>required: **false**<br><p>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.</p><br>
12    ///   - [`storage_encrypted(bool)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::storage_encrypted) / [`set_storage_encrypted(Option<bool>)`](crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::set_storage_encrypted):<br>required: **false**<br><p>The storage encryption setting for the new global cluster.</p><br>
13    /// - On success, responds with [`CreateGlobalClusterOutput`](crate::operation::create_global_cluster::CreateGlobalClusterOutput) with field(s):
14    ///   - [`global_cluster(Option<GlobalCluster>)`](crate::operation::create_global_cluster::CreateGlobalClusterOutput::global_cluster): <p>A data type representing an Amazon DocumentDB global cluster.</p>
15    /// - On failure, responds with [`SdkError<CreateGlobalClusterError>`](crate::operation::create_global_cluster::CreateGlobalClusterError)
16    pub fn create_global_cluster(&self) -> crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder {
17        crate::operation::create_global_cluster::builders::CreateGlobalClusterFluentBuilder::new(self.handle.clone())
18    }
19}