Struct aws_sdk_rds::input::RestoreDbClusterToPointInTimeInput

source · [−]

#[non_exhaustive]
pub struct RestoreDbClusterToPointInTimeInput {Show 25 fields
    pub db_cluster_identifier: Option<String>,
    pub restore_type: Option<String>,
    pub source_db_cluster_identifier: Option<String>,
    pub restore_to_time: Option<DateTime>,
    pub use_latest_restorable_time: bool,
    pub port: Option<i32>,
    pub db_subnet_group_name: Option<String>,
    pub option_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_iam_database_authentication: Option<bool>,
    pub backtrack_window: Option<i64>,
    pub enable_cloudwatch_logs_exports: Option<Vec<String>>,
    pub db_cluster_parameter_group_name: Option<String>,
    pub deletion_protection: Option<bool>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub domain: Option<String>,
    pub domain_iam_role_name: Option<String>,
    pub scaling_configuration: Option<ScalingConfiguration>,
    pub engine_mode: Option<String>,
    pub db_cluster_instance_class: Option<String>,
    pub storage_type: Option<String>,
    pub publicly_accessible: Option<bool>,
    pub iops: Option<i32>,
}

Expand description

Fields (Non-exhaustive)

This struct is marked as 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.

db_cluster_identifier: Option<String>

The name of the new DB cluster to be created.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restore_type: Option<String>

The type of restore to be performed. You can specify one of the following values:

full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

source_db_cluster_identifier: Option<String>

The identifier of the source DB cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

restore_to_time: Option<DateTime>

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

Valid for: Aurora DB clusters and Multi-AZ DB clusters

use_latest_restorable_time: bool

A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

Constraints: Can't be specified if RestoreToTime parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

port: Option<i32>

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

db_subnet_group_name: Option<String>

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

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

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

option_group_name: Option<String>

The name of the option group for the new DB cluster.

DB clusters are associated with a default option group that can't be modified.

vpc_security_group_ids: Option<Vec<String>>

A list of VPC security groups that the new DB cluster belongs to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

tags: Option<Vec<Tag>>

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

kms_key_id: Option<String>

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

enable_iam_database_authentication: Option<bool>

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

backtrack_window: Option<i64>

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

enable_cloudwatch_logs_exports: Option<Vec<String>>

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

db_cluster_parameter_group_name: Option<String>

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

deletion_protection: Option<bool>

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

copy_tags_to_snapshot: Option<bool>

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters only

domain: Option<String>

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

domain_iam_role_name: Option<String>

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

scaling_configuration: Option<ScalingConfiguration>

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

engine_mode: Option<String>

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Valid for: Aurora DB clusters only

db_cluster_instance_class: Option<String>

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

storage_type: Option<String>

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

publicly_accessible: Option<bool>

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

iops: Option<i32>

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Multi-AZ DB clusters only

Struct aws_sdk_rds::input::RestoreDbClusterToPointInTimeInput

Fields (Non-exhaustive)

Implementations

impl RestoreDbClusterToPointInTimeInput

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

pub fn builder() -> Builder

impl RestoreDbClusterToPointInTimeInput

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

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

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

pub fn restore_to_time(&self) -> Option<&DateTime>

pub fn use_latest_restorable_time(&self) -> bool

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

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

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

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

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

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

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

pub fn backtrack_window(&self) -> Option<i64>

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

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

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

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

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

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

pub fn scaling_configuration(&self) -> Option<&ScalingConfiguration>

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

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

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

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

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

Trait Implementations

impl Clone for RestoreDbClusterToPointInTimeInput

fn clone(&self) -> RestoreDbClusterToPointInTimeInput

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

impl Debug for RestoreDbClusterToPointInTimeInput

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

impl PartialEq<RestoreDbClusterToPointInTimeInput> for RestoreDbClusterToPointInTimeInput

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

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

impl StructuralPartialEq for RestoreDbClusterToPointInTimeInput

Auto Trait Implementations

impl RefUnwindSafe for RestoreDbClusterToPointInTimeInput

impl Send for RestoreDbClusterToPointInTimeInput

impl Sync for RestoreDbClusterToPointInTimeInput

impl Unpin for RestoreDbClusterToPointInTimeInput

impl UnwindSafe for RestoreDbClusterToPointInTimeInput

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,