AWS SDK Version 2 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.

.NET Framework 4.5
 
Container for the parameters to the RestoreDBInstanceToPointInTime operation. Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet 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 deployment and not a single-AZ deployment.

Inheritance Hierarchy

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

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class RestoreDBInstanceToPointInTimeRequest : AmazonRDSRequest
         IRequestEvents

The RestoreDBInstanceToPointInTimeRequest type exposes the following members

Constructors

NameDescription
Public Method RestoreDBInstanceToPointInTimeRequest() Empty constructor used to set properties independently even when a simple constructor is available
Public Method RestoreDBInstanceToPointInTimeRequest(string, string) Instantiates RestoreDBInstanceToPointInTimeRequest 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

Default: The same DBInstanceClass as the original DB instance.

Public Property DBName System.String Gets and sets the property DBName.

The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

Public Property DBSubnetGroupName System.String Gets and sets the property DBSubnetGroupName.

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

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

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.

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

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.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

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 RestoreTime System.DateTime Gets and sets the property RestoreTime.

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance
  • Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

Public Property SourceDBInstanceIdentifier System.String Gets and sets the property SourceDBInstanceIdentifier.

The identifier of the source DB instance from which to restore.

Constraints:

  • Must be the identifier of an existing database instance
  • 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
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 TargetDBInstanceIdentifier System.String Gets and sets the property TargetDBInstanceIdentifier.

The name of the new database instance to be created.

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

Public Property UseLatestRestorableTime System.Boolean Gets and sets the property UseLatestRestorableTime.

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

Version Information

.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