Struct aws_sdk_docdb::input::RestoreDbClusterFromSnapshotInput

source · [−]

#[non_exhaustive]
pub struct RestoreDbClusterFromSnapshotInput { /* private fields */ }

Expand description

Represents the input to RestoreDBClusterFromSnapshot.

Implementations

source

impl RestoreDbClusterFromSnapshotInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<RestoreDBClusterFromSnapshot, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<RestoreDBClusterFromSnapshot>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RestoreDbClusterFromSnapshotInput.

source

impl RestoreDbClusterFromSnapshotInput

source

pub fn availability_zones(&self) -> Option<&[String]>

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

source

pub fn db_cluster_identifier(&self) -> Option<&str>

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

source

pub fn snapshot_identifier(&self) -> Option<&str>

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.

source

pub fn engine(&self) -> Option<&str>

The database engine to use for the new cluster.

Default: The same as source.

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

source

pub fn engine_version(&self) -> Option<&str>

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

source

pub fn port(&self) -> Option<i32>

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.

source

pub fn db_subnet_group_name(&self) -> Option<&str>

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

source

pub fn vpc_security_group_ids(&self) -> Option<&[String]>

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

source

pub fn tags(&self) -> Option<&[Tag]>

The tags to be assigned to the restored cluster.

source

pub fn kms_key_id(&self) -> Option<&str>

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.

source

pub fn enable_cloudwatch_logs_exports(&self) -> Option<&[String]>

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

source

pub fn deletion_protection(&self) -> Option<bool>

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.