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

Syntax

Restore-RDSDBInstanceFromS3
-DBInstanceIdentifier <String>
-AllocatedStorage <Int32>
-AutoMinorVersionUpgrade <Boolean>
-AvailabilityZone <String>
-BackupRetentionPeriod <Int32>
-CopyTagsToSnapshot <Boolean>
-DBInstanceClass <String>
-DBName <String>
-DBParameterGroupName <String>
-DBSecurityGroup <String[]>
-DBSubnetGroupName <String>
-EnableIAMDatabaseAuthentication <Boolean>
-EnablePerformanceInsight <Boolean>
-Engine <String>
-EngineVersion <String>
-Iops <Int32>
-KmsKeyId <String>
-LicenseModel <String>
-MasterUsername <String>
-MasterUserPassword <String>
-MonitoringInterval <Int32>
-MonitoringRoleArn <String>
-MultiAZ <Boolean>
-OptionGroupName <String>
-PerformanceInsightsKMSKeyId <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-S3BucketName <String>
-S3IngestionRoleArn <String>
-S3Prefix <String>
-SourceEngine <String>
-SourceEngineVersion <String>
-StorageEncrypted <Boolean>
-StorageType <String>
-Tag <Tag[]>
-VpcSecurityGroupId <String[]>
-Force <SwitchParameter>

Description

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance.

Parameters

-AllocatedStorage <Int32>
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
Required?False
Position?Named
Accept pipeline input?False
-AutoMinorVersionUpgrade <Boolean>
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false. Default: true
Required?False
Position?Named
Accept pipeline input?False
-AvailabilityZone <String>
The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1dConstraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.
Required?False
Position?Named
Accept pipeline input?False
-BackupRetentionPeriod <Int32>
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
Required?False
Position?Named
Accept pipeline input?False
-CopyTagsToSnapshot <Boolean>
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. Default: false.
Required?False
Position?Named
Accept pipeline input?False
-DBInstanceClass <String>
The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceIdentifier <String>
The DB instance identifier. This parameter is stored as a lowercase string. 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: mydbinstance
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DBName <String>
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
Required?False
Position?Named
Accept pipeline input?False
-DBParameterGroupName <String>
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSecurityGroup <String[]>
A list of DB security groups to associate with this DB instance.Default: The default DB security group for the database engine.
Required?False
Position?Named
Accept pipeline input?False
-DBSubnetGroupName <String>
A DB subnet group to associate with this DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableIAMDatabaseAuthentication <Boolean>
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
-EnablePerformanceInsight <Boolean>
True to enable Performance Insights for the DB instance, and otherwise false.
Required?False
Position?Named
Accept pipeline input?False
-Engine <String>
The name of the database engine to be used for this instance. Valid Values: mysql
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance.
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
-Iops <Int32>
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Required?False
Position?Named
Accept pipeline input?False
-KmsKeyId <String>
The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, 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
-LicenseModel <String>
The license model for this DB instance. Use general-public-license.
Required?False
Position?Named
Accept pipeline input?False
-MasterUsername <String>
The name for the master user. 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 user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
Required?False
Position?Named
Accept pipeline input?False
-MonitoringInterval <Int32>
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Default: 0
Required?False
Position?Named
Accept pipeline input?False
-MonitoringRoleArn <String>
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
Required?False
Position?Named
Accept pipeline input?False
-MultiAZ <Boolean>
Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.
Required?False
Position?Named
Accept pipeline input?False
-OptionGroupName <String>
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsKMSKeyId <String>
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port number on which the database accepts connections. Type: Integer Valid Values: 1150-65535Default: 3306
Required?False
Position?Named
Accept pipeline input?False
-PreferredBackupWindow <String>
The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window. 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?False
-PreferredMaintenanceWindow <String>
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window. Constraints:
  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.
  • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred backup window.
  • Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?False
-PubliclyAccessible <Boolean>
Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance.
Required?False
Position?Named
Accept pipeline input?False
-S3BucketName <String>
The name of your Amazon S3 bucket that contains your database backup file.
Required?False
Position?Named
Accept pipeline input?False
-S3IngestionRoleArn <String>
An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?False
-S3Prefix <String>
The prefix of your Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?False
-SourceEngine <String>
The name of the engine of your source database. Valid Values: mysql
Required?False
Position?Named
Accept pipeline input?False
-SourceEngineVersion <String>
The engine version of your source database. Valid Values: 5.6
Required?False
Position?Named
Accept pipeline input?False
-StorageEncrypted <Boolean>
Specifies whether the new DB instance is encrypted or not.
Required?False
Position?Named
Accept pipeline input?False
-StorageType <String>
Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
Required?False
Position?Named
Accept pipeline input?False
-Tag <Tag[]>
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources.
Required?False
Position?Named
Accept pipeline input?False
-VpcSecurityGroupId <String[]>
A list of VPC security groups to associate with this DB instance.
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 DBInstanceIdentifier parameter.

Outputs

This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.RestoreDBInstanceFromS3Response) 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