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

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.RestoreDBClusterToPointInTimeRequest

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

Syntax

C#
public class RestoreDBClusterToPointInTimeRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The RestoreDBClusterToPointInTimeRequest type exposes the following members

Constructors

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 letters, numbers, or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Public Property DBClusterParameterGroupName System.String

Gets and sets the property DBClusterParameterGroupName.

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

Public Property DBSubnetGroupName System.String

Gets and sets the property DBSubnetGroupName.

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

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Public Property DeletionProtection System.Boolean

Gets and sets the property DeletionProtection.

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Public Property EnableCloudwatchLogsExports System.Collections.Generic.List<System.String>

Gets and sets the property EnableCloudwatchLogsExports.

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

Public Property EnableIAMDatabaseAuthentication System.Boolean

Gets and sets the property EnableIAMDatabaseAuthentication.

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

Default: false

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The Amazon 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 Amazon 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 is 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 not encrypted, then the restore request is rejected.

Public Property OptionGroupName System.String

Gets and sets the property OptionGroupName.

(Not supported by Neptune)

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

This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use RestoreToTimeUtc instead. Setting either RestoreToTime or RestoreToTimeUtc results in both RestoreToTime and RestoreToTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. RestoreToTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.

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

  • Must be specified if UseLatestRestorableTime parameter is not provided

  • Cannot be specified if UseLatestRestorableTime parameter is true

  • Cannot be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

Public Property RestoreToTimeUtc System.DateTime

Gets and sets the property RestoreToTimeUtc.

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

  • Must be specified if UseLatestRestorableTime parameter is not provided

  • Cannot be specified if UseLatestRestorableTime parameter is true

  • Cannot be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

Public Property RestoreType System.String

Gets and sets the property RestoreType.

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Public Property SourceDBClusterIdentifier System.String

Gets and sets the property SourceDBClusterIdentifier.

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

Constraints:

  • Must match the identifier of an existing DBCluster.

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

Gets and sets the property Tags.

The tags to be applied to the restored DB cluster.

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 list of VPC security groups that the new DB cluster belongs to.

Examples

The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.

To restore a DB cluster to a point in time.


var response = client.RestoreDBClusterToPointInTime(new RestoreDBClusterToPointInTimeRequest 
{
    DBClusterIdentifier = "sample-restored-cluster1",
    RestoreToTime = new DateTime(2016, 9, 13, 11, 45, 0),
    SourceDBClusterIdentifier = "sample-cluster1"
});

DBCluster dbCluster = response.DBCluster;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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