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

Calls the Amazon Relational Database Service RestoreDBClusterFromSnapshot API operation.

Syntax

Restore-RDSDBClusterFromSnapshot
-DBClusterIdentifier <String>
-ScalingConfiguration_AutoPause <Boolean>
-AvailabilityZone <String[]>
-BacktrackWindow <Int64>
-CopyTagsToSnapshot <Boolean>
-DatabaseName <String>
-DBClusterParameterGroupName <String>
-DBSubnetGroupName <String>
-DeletionProtection <Boolean>
-Domain <String>
-DomainIAMRoleName <String>
-EnableCloudwatchLogsExport <String[]>
-EnableIAMDatabaseAuthentication <Boolean>
-Engine <String>
-EngineMode <String>
-EngineVersion <String>
-KmsKeyId <String>
-ScalingConfiguration_MaxCapacity <Int32>
-ScalingConfiguration_MinCapacity <Int32>
-OptionGroupName <String>
-Port <Int32>
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
-SnapshotIdentifier <String>
-Tag <Tag[]>
-ScalingConfiguration_TimeoutAction <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default 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 RestoreDBClusterFromSnapshot action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.

Parameters

-AvailabilityZone <String[]>
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvailabilityZones
-BacktrackWindow <Int64>
The target backtrack window, in seconds. To disable backtracking, set this value to 0.Currently, Backtrack is only supported for Aurora MySQL DB clusters.Default: 0Constraints:
  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CopyTagsToSnapshot <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
The database name for the restored DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterIdentifier <String>
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.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
Example: my-snapshot-id
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBClusterParameterGroupName <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 default 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSubnetGroupName <String>
The name of the DB subnet group to use for the new DB cluster.Constraints: If supplied, must match the name of an existing DB subnet group.Example: mySubnetgroup
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
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 is disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIAMRoleName <String>
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableCloudwatchLogsExport <String[]>
The list of logs that the restored DB cluster is to export to Amazon 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnableCloudwatchLogsExports
-EnableIAMDatabaseAuthentication <Boolean>
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <String>
The database engine to use for the new DB cluster.Default: The same as sourceConstraint: Must be compatible with the engine of the source
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineMode <String>
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version of the database engine to use for the new DB cluster.To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"To list all of the available engine versions for aurora-postgresql, use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"If you aren't using the default engine version, then you must specify the engine version.Aurora MySQLExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5Aurora PostgreSQLExample: 9.6.3, 10.7
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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?True (ByPropertyName)
-KmsKeyId <String>
The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.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.If you don't specify a value for the KmsKeyId parameter, then the following occurs:
  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
The name of the option group to use for the restored DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBClusterIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the new DB cluster accepts connections.Constraints: This value must be 1150-65535Default: The same port as the original DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_AutoPause <Boolean>
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_MaxCapacity <Int32>
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_MinCapacity <Int32>
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_SecondsUntilAutoPause <Int32>
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingConfiguration_TimeoutAction <String>
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DBCluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse). Specifying the name of a property of type Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotIdentifier <String>
The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.Constraints:
  • Must match the identifier of an existing Snapshot.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tags to be assigned to the restored DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcSecurityGroupId <String[]>
A list of VPC security groups that the new DB cluster will belong to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.RDS.Model.DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse) 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