AWS SDK Version 3 for .NET
API 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.

Container for the parameters to the RestoreDBInstanceFromDBSnapshot operation. Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default 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 that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class RestoreDBInstanceFromDBSnapshotRequest : AmazonRDSRequest
         IAmazonWebServiceRequest

The RestoreDBInstanceFromDBSnapshotRequest type exposes the following members

Constructors

NameDescription
Public Method RestoreDBInstanceFromDBSnapshotRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method RestoreDBInstanceFromDBSnapshotRequest(string, string)

Instantiates RestoreDBInstanceFromDBSnapshotRequest with the parameterized properties

Properties

NameTypeDescription
Public Property 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.

Public Property 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 true.

Example: us-east-1a

Public Property 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.

Public Property 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

Public Property 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:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Public Property 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, PostgreSQL, or MariaDB engines.

Public Property DBSnapshotIdentifier System.String

Gets and sets the property DBSnapshotIdentifier.

The identifier for the DB snapshot to restore from.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Public Property DBSubnetGroupName System.String

Gets and sets the property DBSubnetGroupName.

The DB subnet group name to use for the new instance.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Public Property Domain System.String

Gets and sets the property Domain.

Specify the Active Directory Domain to restore the instance in.

Public Property DomainIAMRoleName System.String

Gets and sets the property DomainIAMRoleName.

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Public Property EnableIAMDatabaseAuthentication System.Boolean

Gets and sets the property EnableIAMDatabaseAuthentication.

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher.

Default: false

Public Property 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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

Public Property 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.

Public Property LicenseModel System.String

Gets and sets the property LicenseModel.

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Public Property 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 true.

Public Property 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

Public Property 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 1150-65535

Public Property 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.

  • Default VPC: true

  • VPC: false

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.

Public Property StorageType System.String

Gets and sets the property StorageType.

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

Public Property Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag>

Gets and sets the property Tags.

Public Property TdeCredentialArn System.String

Gets and sets the property TdeCredentialArn.

The ARN from the Key Store with which to associate the instance for TDE encryption.

Public Property 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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms