aws_sdk_docdbelastic/client/
restore_cluster_from_snapshot.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 [`RestoreClusterFromSnapshot`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_name(impl Into<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name of the elastic cluster.</p><br>
7    ///   - [`snapshot_arn(impl Into<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::snapshot_arn) / [`set_snapshot_arn(Option<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_snapshot_arn):<br>required: **true**<br><p>The ARN identifier of the elastic cluster snapshot.</p><br>
8    ///   - [`vpc_security_group_ids(impl Into<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::vpc_security_group_ids) / [`set_vpc_security_group_ids(Option<Vec::<String>>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_vpc_security_group_ids):<br>required: **false**<br><p>A list of EC2 VPC security groups to associate with the elastic cluster.</p><br>
9    ///   - [`subnet_ids(impl Into<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::subnet_ids) / [`set_subnet_ids(Option<Vec::<String>>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_subnet_ids):<br>required: **false**<br><p>The Amazon EC2 subnet IDs for the elastic cluster.</p><br>
10    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.</p> <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.</p> <p>If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.</p><br>
11    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_tags):<br>required: **false**<br><p>A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.</p><br>
12    ///   - [`shard_capacity(i32)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::shard_capacity) / [`set_shard_capacity(Option<i32>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_shard_capacity):<br>required: **false**<br><p>The capacity of each shard in the new restored elastic cluster.</p><br>
13    ///   - [`shard_instance_count(i32)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::shard_instance_count) / [`set_shard_instance_count(Option<i32>)`](crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::set_shard_instance_count):<br>required: **false**<br><p>The number of replica instances applying to all shards in the elastic cluster. A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</p><br>
14    /// - On success, responds with [`RestoreClusterFromSnapshotOutput`](crate::operation::restore_cluster_from_snapshot::RestoreClusterFromSnapshotOutput) with field(s):
15    ///   - [`cluster(Option<Cluster>)`](crate::operation::restore_cluster_from_snapshot::RestoreClusterFromSnapshotOutput::cluster): <p>Returns information about a the restored elastic cluster.</p>
16    /// - On failure, responds with [`SdkError<RestoreClusterFromSnapshotError>`](crate::operation::restore_cluster_from_snapshot::RestoreClusterFromSnapshotError)
17    pub fn restore_cluster_from_snapshot(
18        &self,
19    ) -> crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder {
20        crate::operation::restore_cluster_from_snapshot::builders::RestoreClusterFromSnapshotFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_docdbelastic/client/restore_cluster_from_snapshot.rs

aws_sdk_docdbelastic/client/
restore_cluster_from_snapshot.rs
