Struct aws_sdk_docdb::client::fluent_builders::RestoreDBClusterFromSnapshot

pub struct RestoreDBClusterFromSnapshot { /* private fields */ }

Fluent builder constructing a request to RestoreDBClusterFromSnapshot.

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

Implementations

impl RestoreDBClusterFromSnapshot

pub async fn send(
    self
) -> Result<RestoreDbClusterFromSnapshotOutput, SdkError<RestoreDBClusterFromSnapshotError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn availability_zones(self, input: impl Into<String>) -> Self

Appends an item to AvailabilityZones.

To override the contents of this collection use set_availability_zones.

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

pub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

pub fn db_cluster_identifier(self, input: impl Into<String>) -> Self

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

pub fn set_db_cluster_identifier(self, input: Option<String>) -> Self

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

pub fn snapshot_identifier(self, input: impl Into<String>) -> Self

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

pub fn set_snapshot_identifier(self, input: Option<String>) -> Self

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

pub fn engine(self, input: impl Into<String>) -> Self

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

pub fn set_engine(self, input: Option<String>) -> Self

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

pub fn engine_version(self, input: impl Into<String>) -> Self

The version of the database engine to use for the new cluster.

pub fn set_engine_version(self, input: Option<String>) -> Self

The version of the database engine to use for the new cluster.

pub fn port(self, input: i32) -> Self

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

pub fn set_port(self, input: Option<i32>) -> Self

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

pub fn db_subnet_group_name(self, input: impl Into<String>) -> Self

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

pub fn set_db_subnet_group_name(self, input: Option<String>) -> Self

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

pub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to VpcSecurityGroupIds.

To override the contents of this collection use set_vpc_security_group_ids.

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

pub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The tags to be assigned to the restored cluster.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags to be assigned to the restored cluster.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

• If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

• If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

pub fn set_kms_key_id(self, input: Option<String>) -> Self

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

• If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

• If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

pub fn enable_cloudwatch_logs_exports(self, input: impl Into<String>) -> Self

Appends an item to EnableCloudwatchLogsExports.

To override the contents of this collection use set_enable_cloudwatch_logs_exports.

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

pub fn set_enable_cloudwatch_logs_exports(
    self,
    input: Option<Vec<String>>
) -> Self

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

pub fn deletion_protection(self, input: bool) -> Self

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

pub fn set_deletion_protection(self, input: Option<bool>) -> Self

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Trait Implementations

impl Clone for RestoreDBClusterFromSnapshot

fn clone(&self) -> RestoreDBClusterFromSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestoreDBClusterFromSnapshot

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

Formats the value using the given formatter.