Restores a DB cluster to an arbitrary point in time. Users can restore
to any point in time before LatestRestorableTime for up to
BackupRetentionPeriod days. The target DB cluster is created from the
source DB cluster with the same configuration as the original DB
cluster, except that the new DB cluster is created with the default DB
security group.
docdb_restore_db_cluster_to_point_in_time(DBClusterIdentifier,
SourceDBClusterIdentifier, RestoreToTime, UseLatestRestorableTime, Port,
DBSubnetGroupName, VpcSecurityGroupIds, Tags, KmsKeyId,
EnableCloudwatchLogsExports, DeletionProtection)[required] The name of the new DB 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.
[required] The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
The date and time to restore the DB cluster to.
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
Must be before the latest restorable time for the DB 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
A value that is set to true to restore the DB cluster to the latest
restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime parameter is
provided.
The port number on which the new DB cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The default port for the engine.
The DB subnet group name to use for the new DB cluster.
Constraints: If provided, must match the name of an existing
DBSubnetGroup.
Example: mySubnetgroup
A list of VPC security groups that the new DB cluster belongs to.
The tags to be assigned to the restored DB cluster.
The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with
an AWS KMS key that is different from the AWS KMS key used to encrypt
the source DB cluster. The new DB cluster is encrypted with the AWS KMS
key identified by the KmsKeyId parameter.
If you do not 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 AWS KMS key that was used to encrypt the source DB cluster.
If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If DBClusterIdentifier refers to a DB cluster that is not encrypted,
then the restore request is rejected.
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
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.
svc$restore_db_cluster_to_point_in_time(
DBClusterIdentifier = "string",
SourceDBClusterIdentifier = "string",
RestoreToTime = as.POSIXct(
"2015-01-01"
),
UseLatestRestorableTime = TRUE|FALSE,
Port = 123,
DBSubnetGroupName = "string",
VpcSecurityGroupIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
KmsKeyId = "string",
EnableCloudwatchLogsExports = list(
"string"
),
DeletionProtection = TRUE|FALSE
)