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

Syntax

Restore-RDSDBInstanceFromDBSnapshot
-DBInstanceIdentifier <String>
-DBSnapshotIdentifier <String>
-AllocatedStorage <Int32>
-AutoMinorVersionUpgrade <Boolean>
-AvailabilityZone <String>
-BackupTarget <String>
-CACertificateIdentifier <String>
-CopyTagsToSnapshot <Boolean>
-CustomIamInstanceProfile <String>
-DBClusterSnapshotIdentifier <String>
-DBInstanceClass <String>
-DBName <String>
-DBParameterGroupName <String>
-DBSubnetGroupName <String>
-DedicatedLogVolume <Boolean>
-DeletionProtection <Boolean>
-Domain <String>
-DomainAuthSecretArn <String>
-DomainDnsIp <String[]>
-DomainFqdn <String>
-DomainIAMRoleName <String>
-DomainOu <String>
-EnableCloudwatchLogsExport <String[]>
-EnableCustomerOwnedIp <Boolean>
-EnableIAMDatabaseAuthentication <Boolean>
-Engine <String>
-Iops <Int32>
-LicenseModel <String>
-MultiAZ <Boolean>
-NetworkType <String>
-OptionGroupName <String>
-Port <Int32>
-ProcessorFeature <ProcessorFeature[]>
-PubliclyAccessible <Boolean>
-StorageThroughput <Int32>
-StorageType <String>
-Tag <Tag[]>
-TdeCredentialArn <String>
-TdeCredentialPassword <String>
-UseDefaultProcessorFeature <Boolean>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment. If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

Parameters

-AllocatedStorage <Int32>
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoMinorVersionUpgrade <Boolean>
Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.If you restore an RDS Custom DB instance, you must disable this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZone <String>
The Availability Zone (AZ) where the DB instance will be created.Default: A random, system-chosen Availability Zone.Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.Example: us-east-1a
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BackupTarget <String>
Specifies where automated backups and manual snapshots are stored for the restored DB instance.Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CACertificateIdentifier <String>
The CA certificate identifier to use for the DB instance's server certificate.This setting doesn't apply to RDS Custom DB instances.For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
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 instance to snapshots of the DB instance.In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomIamInstanceProfile <String>
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.This setting is required for RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBClusterSnapshotIdentifier <String>
The identifier for the Multi-AZ DB cluster snapshot to restore from.For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.Constraints:
  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceClass <String>
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services 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.Default: The same DBInstanceClass as the original DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceIdentifier <String>
The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.Constraints:
  • Must contain from 1 to 63 numbers, letters, 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)
-DBName <String>
The name of the database for the restored DB instance.This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBParameterGroupName <String>
The name of the DB parameter group to associate with this DB instance.If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.This setting doesn't apply to RDS Custom.Constraints:
  • If supplied, must match the name of an existing DB 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)
-DBSnapshotIdentifier <String>
The identifier for the DB snapshot to restore from.Constraints:
  • Must match the identifier of an existing DB snapshot.
  • Can't be specified when DBClusterSnapshotIdentifier is specified.
  • Must be specified when DBClusterSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-DBSubnetGroupName <String>
The name of the DB subnet group to use for the new instance.Constraints:
  • If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DedicatedLogVolume <Boolean>
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtection <Boolean>
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
The Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.For more information, see Kerberos Authentication in the Amazon RDS User Guide.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainAuthSecretArn <String>
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.Constraints:
  • Can't be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainDnsIp <String[]>
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.Constraints:
  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainDnsIps
-DomainFqdn <String>
The fully qualified domain name (FQDN) of an Active Directory domain.Constraints:
  • Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainIAMRoleName <String>
The name of the IAM role to use when making API calls to the Directory Service.This setting doesn't apply to RDS Custom DB instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainOu <String>
The Active Directory organizational unit for your DB instance to join.Constraints:
  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableCloudwatchLogsExport <String[]>
The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnableCloudwatchLogsExports
-EnableCustomerOwnedIp <Boolean>
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.This setting doesn't apply to RDS Custom.For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableIAMDatabaseAuthentication <Boolean>
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <String>
The database engine to use for the new instance.This setting doesn't apply to RDS Custom.Default: The same as sourceConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.Valid Values:
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
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)
-Iops <Int32>
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.Constraints: Must be an integer greater than 1000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LicenseModel <String>
License model information for the restored DB instance.This setting doesn't apply to RDS Custom.Default: Same as source.Valid Values: license-included | bring-your-own-license | general-public-license
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MultiAZ <Boolean>
Specifies whether the DB instance is a Multi-AZ deployment.This setting doesn't apply to RDS Custom.Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <String>
The network type of the DB instance.Valid Values:
  • IPV4
  • DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionGroupName <String>
The name of the option group to be used for the restored DB instance.Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBInstanceIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' 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 database accepts connections.Default: The same port as the original DB instanceConstraints: Value must be 1150-65535
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcessorFeature <ProcessorFeature[]>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProcessorFeatures
-PubliclyAccessible <Boolean>
Specifies whether the DB instance is publicly accessible.When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.For more information, see CreateDBInstance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DBInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotResponse). Specifying the name of a property of type Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotResponse 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)
-StorageThroughput <Int32>
Specifies the storage throughput value for the DB instance.This setting doesn't apply to RDS Custom or Amazon Aurora.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <String>
Specifies the storage type to be associated with the DB instance.Valid Values: gp2 | gp3 | io1 | io2 | standardIf you specify io1, io2, or gp3, you must also include a value for the Iops parameter.Default: io1 if the Iops parameter is specified, otherwise gp2
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
-TdeCredentialArn <String>
The ARN from the key store with which to associate the instance for TDE encryption.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TdeCredentialPassword <String>
The password for the given ARN from the key store in order to access the device.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UseDefaultProcessorFeature <Boolean>
Specifies whether the DB instance class of the DB instance uses its default processor features.This setting doesn't apply to RDS Custom.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUseDefaultProcessorFeatures
-VpcSecurityGroupId <String[]>
A list of EC2 VPC security groups to associate with this DB instance.Default: The default EC2 VPC security group for the DB subnet group's VPC.
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.DBInstance or Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotResponse
This cmdlet returns an Amazon.RDS.Model.DBInstance object. The service call response (type Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotResponse) 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