Synopsis
Calls the Amazon DocumentDB RestoreDBClusterToPointInTime API operation.
Syntax
Restore-DOCDBClusterToPointInTime-DBClusterIdentifier <String>-DBSubnetGroupName <String>-DeletionProtection <Boolean>-EnableCloudwatchLogsExport <String[]>-KmsKeyId <String>-Port <Int32>-RestoreToTime <DateTime>-SourceDBClusterIdentifier <String>-Tag <Tag[]>-UseLatestRestorableTime <Boolean>-VpcSecurityGroupId <String[]>-Force <SwitchParameter>
Description
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. Parameters
-DBClusterIdentifier <String>
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? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-DBSubnetGroupName <String>
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 | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DeletionProtection <Boolean>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EnableCloudwatchLogsExport <String[]>
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | EnableCloudwatchLogsExports |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-KmsKeyId <String>
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.
DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Port <Int32>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-RestoreToTime <DateTime>
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
UseLatestRestorableTimeparameter is not provided. - Cannot be specified if the
UseLatestRestorableTimeparameter istrue. - Cannot be specified if the
RestoreTypeparameter iscopy-on-write.
2015-03-07T23:45:00Z | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SourceDBClusterIdentifier <String>
The identifier of the source DB cluster from which to restore.Constraints:
- Must match the identifier of an existing
DBCluster.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Tag <Tag[]>
The tags to be assigned to the restored DB cluster.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Tags |
-UseLatestRestorableTime <Boolean>
A value that is set to
true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: falseConstraints: Cannot be specified if the RestoreToTime parameter is provided. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-VpcSecurityGroupId <String[]>
A list of VPC security groups that the new DB cluster belongs to.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | VpcSecurityGroupIds |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the DBClusterIdentifier parameter.
Outputs
This cmdlet returns a Amazon.DocDB.Model.DBCluster object.
The service call response (type Amazon.DocDB.Model.RestoreDBClusterToPointInTimeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
