AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the RestoreDBClusterToPointInTime operation against Amazon Relational Database Service.

Syntax

Restore-RDSDBClusterToPointInTime
-DBClusterIdentifier <String>
-DBSubnetGroupName <String>
-EnableIAMDatabaseAuthentication <Boolean>
-KmsKeyId <String>
-OptionGroupName <String>
-Port <Int32>
-RestoreToTime <DateTime>
-RestoreType <String>
-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. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Parameters

-DBClusterIdentifier <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
  • Cannot end with a hyphen or contain two consecutive hyphens
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-DBSubnetGroupName <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: mySubnetgroup
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableIAMDatabaseAuthentication <Boolean>
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.Default: false
Required?False
Position?Named
Accept pipeline input?False
-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 KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.If you do not specify a value for the KmsKeyId parameter, then the following will occur:
  • 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 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.
Required?False
Position?Named
Accept pipeline input?False
-OptionGroupName <String>
The name of the option group for the new DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the new DB cluster accepts connections.Constraints: Value must be 1150-65535Default: The same port as the original DB cluster.
Required?False
Position?Named
Accept pipeline input?False
-RestoreToTime <DateTime>
The date and time to restore the DB cluster to.Valid Values: Value must be a time in Universal Coordinated Time (UTC) formatConstraints:
  • Must be before the latest restorable time for the DB instance
  • Must be specified if UseLatestRestorableTime parameter is not provided
  • Cannot be specified if UseLatestRestorableTime parameter is true
  • Cannot be specified if RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Required?False
Position?Named
Accept pipeline input?False
-RestoreType <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 cannot 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.
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[]>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-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 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

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 DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterToPointInTimeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z