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 RestoreDBClusterFromS3 API operation.

Syntax

Restore-RDSDBClusterFromS3
-DBClusterIdentifier <String>
-AvailabilityZone <String[]>
-BacktrackWindow <Int64>
-BackupRetentionPeriod <Int32>
-CharacterSetName <String>
-CopyTagsToSnapshot <Boolean>
-DatabaseName <String>
-DBClusterParameterGroupName <String>
-DBSubnetGroupName <String>
-DeletionProtection <Boolean>
-Domain <String>
-DomainIAMRoleName <String>
-EnableCloudwatchLogsExport <String[]>
-EnableIAMDatabaseAuthentication <Boolean>
-Engine <String>
-EngineVersion <String>
-KmsKeyId <String>
-ManageMasterUserPassword <Boolean>
-MasterUsername <String>
-MasterUserPassword <String>
-MasterUserSecretKmsKeyId <String>
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
-NetworkType <String>
-OptionGroupName <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-S3BucketName <String>
-S3IngestionRoleArn <String>
-S3Prefix <String>
-SourceEngine <String>
-SourceEngineVersion <String>
-StorageEncrypted <Boolean>
-StorageType <String>
-Tag <Tag[]>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation 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 RestoreDBClusterFromS3 operation 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 operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

Parameters

-AvailabilityZone <String[]>
A 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)
-BackupRetentionPeriod <Int32>
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.Default: 1Constraints:
  • Must be a value from 1 to 35
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CharacterSetName <String>
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CopyTagsToSnapshot <Boolean>
Specifies 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 source data in the Amazon S3 bucket. 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-cluster1
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.Constraints:
  • If supplied, must match the name of an existing DBClusterParameterGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSubnetGroupName <String>
A DB subnet group to associate with the restored DB cluster.Constraints: If supplied, must match the name of an existing DBSubnetGroup.Example: mydbsubnetgroup
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
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.For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora 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 CloudWatch Logs. The values in the list depend on the DB engine being used.Aurora MySQLPossible values are audit, error, general, and slowquery.For more information about exporting CloudWatch Logs for Amazon Aurora, 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>
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.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 name of the database engine to be used for this DB cluster.Valid Values: aurora-mysql (for Aurora MySQL)
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the database engine to use.To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"Aurora MySQLExamples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-KmsKeyId <String>
The Amazon Web Services KMS key identifier for an encrypted DB cluster.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManageMasterUserPassword <Boolean>
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.Constraints:
  • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUsername <String>
The name of the master user for the restored DB cluster.Constraints:
  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".Constraints:
  • Must contain from 8 to 41 characters.
  • Can't be specified if ManageMasterUserPassword is turned on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserSecretKmsKeyId <String>
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <String>
The network type of the DB cluster.Valid Values:
  • IPV4
  • DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
A value that indicates that the restored DB cluster should be associated with the specified option group.Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a 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 instances in the restored DB cluster accept connections.Default: 3306
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredBackupWindow <String>
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.Constraints:
  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).Format: ddd:hh24:mi-ddd:hh24:miThe default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.Constraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3BucketName <String>
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3IngestionRoleArn <String>
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Prefix <String>
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
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.RestoreDBClusterFromS3Response). Specifying the name of a property of type Amazon.RDS.Model.RestoreDBClusterFromS3Response 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)
-ServerlessV2ScalingConfiguration_MaxCapacity <Double>
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessV2ScalingConfiguration_MinCapacity <Double>
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceEngine <String>
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.Valid Values: mysql
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceEngineVersion <String>
The version of the database that the backup files were created from.MySQL versions 5.7 and 8.0 are supported.Example: 5.7.40, 8.0.28
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageEncrypted <Boolean>
Specifies whether the restored DB cluster is encrypted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <String>
Specifies the storage type to be associated with the DB cluster.Valid Values: aurora, aurora-iopt1Default: auroraValid for: Aurora DB clusters only
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcSecurityGroupId <String[]>
A list of EC2 VPC security groups to associate with the restored DB cluster.
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

Amazon.RDS.Model.DBCluster or Amazon.RDS.Model.RestoreDBClusterFromS3Response
This cmdlet returns an Amazon.RDS.Model.DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterFromS3Response) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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