Struct aws_sdk_docdb::client::fluent_builders::RestoreDBClusterToPointInTime

pub struct RestoreDBClusterToPointInTime<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to RestoreDBClusterToPointInTime.

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

Implementations

impl<C, M, R> RestoreDBClusterToPointInTime<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<RestoreDbClusterToPointInTimeOutput, SdkError<RestoreDBClusterToPointInTimeError>> where
    R::Policy: SmithyRetryPolicy<RestoreDbClusterToPointInTimeInputOperationOutputAlias, RestoreDbClusterToPointInTimeOutput, RestoreDBClusterToPointInTimeError, RestoreDbClusterToPointInTimeInputOperationRetryAlias>, 

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 db_cluster_identifier(self, input: impl Into<String>) -> Self

The name of the new cluster to be created.

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.

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

The name of the new cluster to be created.

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.

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

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster.

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

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster.

pub fn restore_to_time(self, input: DateTime) -> Self

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.

• Must be specified if the UseLatestRestorableTime parameter is not provided.

• Cannot be specified if the UseLatestRestorableTime parameter is true.

• Cannot be specified if the RestoreType parameter is copy-on-write.

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

pub fn set_restore_to_time(self, input: Option<DateTime>) -> Self

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.

• Must be specified if the UseLatestRestorableTime parameter is not provided.

• Cannot be specified if the UseLatestRestorableTime parameter is true.

• Cannot be specified if the RestoreType parameter is copy-on-write.

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

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

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

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

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

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 default port for the engine.

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 default port for the engine.

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

The subnet group name 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 subnet group name 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 VPC security groups that the new cluster belongs to.

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

A list of VPC security groups that the new cluster belongs 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 an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same 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.

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

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

• If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

• If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

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

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same 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.

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

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

• If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

• If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

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<C: Clone, M: Clone, R: Clone> Clone for RestoreDBClusterToPointInTime<C, M, R>

fn clone(&self) -> RestoreDBClusterToPointInTime<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for RestoreDBClusterToPointInTime<C, M, R>

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

Formats the value using the given formatter.