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.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once 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 action. The result is that you will 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.
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class RestoreDBInstanceFromDBSnapshotRequest : AmazonRDSRequest IRequestEvents
The RestoreDBInstanceFromDBSnapshotRequest type exposes the following members
Name | Description | |
---|---|---|
RestoreDBInstanceFromDBSnapshotRequest() | Empty constructor used to set properties independently even when a simple constructor is available | |
RestoreDBInstanceFromDBSnapshotRequest(string, string) | Instantiates RestoreDBInstanceFromDBSnapshotRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property AutoMinorVersionUpgrade.
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. |
|
AvailabilityZone | System.String |
Gets and sets the property AvailabilityZone.
The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter
is set to
Example: |
|
CopyTagsToSnapshot | System.Boolean |
Gets and sets the property CopyTagsToSnapshot.
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. |
|
DBInstanceClass | System.String |
Gets and sets the property DBInstanceClass.
The compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large |
|
DBInstanceIdentifier | System.String |
Gets and sets the property DBInstanceIdentifier.
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints:
Example: |
|
DBName | System.String |
Gets and sets the property DBName.
The database name for the restored DB instance. This parameter doesn't apply to the MySQL or MariaDB engines. |
|
DBSnapshotIdentifier | System.String |
Gets and sets the property DBSnapshotIdentifier.
The identifier for the DB snapshot to restore from. Constraints:
If you are restoring from a shared manual DB snapshot, the |
|
DBSubnetGroupName | System.String |
Gets and sets the property DBSubnetGroupName.
The DB subnet group name to use for the new instance. |
|
Engine | System.String |
Gets and sets the property Engine.
The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source
Valid Values: |
|
Iops | System.Int32 |
Gets and sets the property Iops.
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine is not supported. |
|
LicenseModel | System.String |
Gets and sets the property LicenseModel.
License model information for the restored DB instance. Default: Same as source.
Valid values: |
|
MultiAZ | System.Boolean |
Gets and sets the property MultiAZ.
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter
is set to |
|
OptionGroupName | System.String |
Gets and sets the property OptionGroupName.
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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance |
|
Port | System.Int32 |
Gets and sets the property Port.
The port number on which the database accepts connections. Default: The same port as the original DB instance
Constraints: Value must be |
|
PubliclyAccessible | System.Boolean |
Gets and sets the property PubliclyAccessible.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. |
|
StorageType | System.String |
Gets and sets the property StorageType.
Specifies the storage type to be associated with the DB instance.
Valid values:
If you specify
Default: |
|
Tags | System.Collections.Generic.List<Amazon.RDS.Model.Tag> | Gets and sets the property Tags. | |
TdeCredentialArn | System.String |
Gets and sets the property TdeCredentialArn.
The ARN from the Key Store with which to associate the instance for TDE encryption. |
|
TdeCredentialPassword | System.String |
Gets and sets the property TdeCredentialPassword.
The password for the given ARN from the Key Store in order to access the device. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1