Struct aws_sdk_docdb::operation::restore_db_cluster_from_snapshot::RestoreDbClusterFromSnapshotInput

#[non_exhaustive]
pub struct RestoreDbClusterFromSnapshotInput {

    pub availability_zones: Option<Vec<String>>,
    pub db_cluster_identifier: Option<String>,
    pub snapshot_identifier: Option<String>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub port: Option<i32>,
    pub db_subnet_group_name: Option<String>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
    pub kms_key_id: Option<String>,
    pub enable_cloudwatch_logs_exports: Option<Vec<String>>,
    pub deletion_protection: Option<bool>,
    pub db_cluster_parameter_group_name: Option<String>,
    pub storage_type: Option<String>,
}

Represents the input to RestoreDBClusterFromSnapshot.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

availability_zones: Option<Vec<String>>

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

db_cluster_identifier: Option<String>

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

snapshot_identifier: Option<String>

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.

engine: Option<String>

The database engine to use for the new cluster.

Default: The same as source.

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

engine_version: Option<String>

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

port: 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.

db_subnet_group_name: Option<String>

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

vpc_security_group_ids: Option<Vec<String>>

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

tags: Option<Vec<Tag>>

The tags to be assigned to the restored cluster.

kms_key_id: Option<String>

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.

enable_cloudwatch_logs_exports: Option<Vec<String>>

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

deletion_protection: 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.

db_cluster_parameter_group_name: Option<String>

The name of the DB cluster parameter group to associate with this DB cluster.

Type: String.       Required: No.

If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

storage_type: Option<String>

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Implementations

impl RestoreDbClusterFromSnapshotInput

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zones.is_none().

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

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.

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.

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

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

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.

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

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_group_ids.is_none().

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

The tags to be assigned to the restored cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

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.

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .enable_cloudwatch_logs_exports.is_none().

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.

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

The name of the DB cluster parameter group to associate with this DB cluster.

Type: String.       Required: No.

If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

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

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

impl RestoreDbClusterFromSnapshotInput

pub fn builder() -> RestoreDbClusterFromSnapshotInputBuilder

Creates a new builder-style object to manufacture RestoreDbClusterFromSnapshotInput.

Trait Implementations

impl Clone for RestoreDbClusterFromSnapshotInput

fn clone(&self) -> RestoreDbClusterFromSnapshotInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestoreDbClusterFromSnapshotInput

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

Formats the value using the given formatter.

impl PartialEq for RestoreDbClusterFromSnapshotInput

fn eq(&self, other: &RestoreDbClusterFromSnapshotInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RestoreDbClusterFromSnapshotInput