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 RestoreDBClusterFromS3 operation against Amazon Relational Database Service.

Syntax

Restore-RDSDBClusterFromS3
-DBClusterIdentifier <String>
-AvailabilityZone <String[]>
-BackupRetentionPeriod <Int32>
-CharacterSetName <String>
-DatabaseName <String>
-DBClusterParameterGroupName <String>
-DBSubnetGroupName <String>
-EnableIAMDatabaseAuthentication <Boolean>
-Engine <String>
-EngineVersion <String>
-KmsKeyId <String>
-MasterUsername <String>
-MasterUserPassword <String>
-OptionGroupName <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-S3BucketName <String>
-S3IngestionRoleArn <String>
-S3Prefix <String>
-SourceEngine <String>
-SourceEngineVersion <String>
-StorageEncrypted <Boolean>
-Tag <Tag[]>
-VpcSecurityGroupId <String[]>
-Force <SwitchParameter>

Description

Creates an Amazon Aurora DB cluster from 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.

Parameters

-AvailabilityZone <String[]>
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-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?False
-DatabaseName <String>
The database name for the restored DB cluster.
Required?False
Position?Named
Accept pipeline input?False
-DBClusterIdentifier <String>
The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive.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.
Example: my-cluster1
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 will be used. Constraints:
  • If supplied, must match the name of an existing DBClusterParameterGroup.
Required?False
Position?Named
Accept pipeline input?False
-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: 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
-Engine <String>
The name of the database engine to be used for the restored DB cluster.Valid Values: aurora
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the database engine to use.AuroraExample: 5.6.10a
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?False
-KmsKeyId <String>
The KMS key identifier for an encrypted DB cluster.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating 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 KM encryption key.If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
Required?False
Position?Named
Accept pipeline input?False
-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.
  • Cannot be a reserved word for the chosen database engine.
Required?False
Position?Named
Accept pipeline input?False
-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.
Required?False
Position?Named
Accept pipeline input?False
-OptionGroupName <String>
A value that indicates that the restored DB cluster should be associated with the specified option group.Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.
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?False
-PreferredBackupWindow <String>
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.Constraints:
  • Must be in the format hh24:mi-hh24:mi.
  • Times should 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?False
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:miDefault: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, SunConstraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?False
-S3BucketName <String>
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
Required?False
Position?Named
Accept pipeline input?False
-S3IngestionRoleArn <String>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-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?False
Position?Named
Accept pipeline input?False
-SourceEngineVersion <String>
The version of the database that the backup files were created from.MySQL version 5.5 and 5.6 are supported. Example: 5.6.22
Required?False
Position?Named
Accept pipeline input?False
-StorageEncrypted <Boolean>
Specifies whether the restored DB cluster is encrypted.
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
-VpcSecurityGroupId <String[]>
A list of EC2 VPC security groups to associate with the restored DB cluster.
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.RestoreDBClusterFromS3Response) 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