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 RestoreDBClusterToPointInTime operation. Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Inheritance Hierarchy

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

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

Syntax

C# 
public class RestoreDBClusterToPointInTimeRequest : AmazonRDSRequest
         IRequestEvents

The RestoreDBClusterToPointInTimeRequest type exposes the following members

Constructors

NameDescription
Public Method RestoreDBClusterToPointInTimeRequest()

Properties

NameTypeDescription
Public Property DBClusterIdentifier System.String Gets and sets the property DBClusterIdentifier.

The name of the new DB cluster 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 DBSubnetGroupName System.String Gets and sets the property DBSubnetGroupName.

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

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

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

    • If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.

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

    The name of the option group for the new DB cluster.

    Public Property Port System.Int32 Gets and sets the property Port.

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

    Public Property RestoreToTime System.DateTime Gets and sets the property RestoreToTime.

    The date and time to restore the DB cluster to.

    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: 2015-03-07T23:45:00Z
    Public Property SourceDBClusterIdentifier System.String Gets and sets the property SourceDBClusterIdentifier.

    The identifier of the source DB cluster 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 Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag> Gets and sets the property Tags.
    Public Property UseLatestRestorableTime System.Boolean Gets and sets the property UseLatestRestorableTime.

    A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

    Default: false

    Constraints: Cannot be specified if RestoreToTime parameter is provided.

    Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String> Gets and sets the property VpcSecurityGroupIds.

    A lst of VPC security groups that the new DB cluster belongs to.

    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