RestoreDBClusterFromSnapshotRequest Class

Container for the parameters to the RestoreDBClusterFromSnapshot operation. Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Inheritance Hierarchy

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

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

Syntax

public class RestoreDBClusterFromSnapshotRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The RestoreDBClusterFromSnapshotRequest type exposes the following members

Constructors

	Name	Description
	RestoreDBClusterFromSnapshotRequest()

Properties

Name	Type	Description
AvailabilityZones	System.Collections.Generic.List<System.String>	Gets and sets the property AvailabilityZones. Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
CopyTagsToSnapshot	System.Boolean	Gets and sets the property CopyTagsToSnapshot. If set to `true`, tags are copied to any snapshot of the restored DB cluster that is created.
DatabaseName	System.String	Gets and sets the property DatabaseName. Not supported.
DBClusterIdentifier	System.String	Gets and sets the property DBClusterIdentifier. The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. 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 Example: `my-snapshot-id`
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.
DBSubnetGroupName	System.String	Gets and sets the property DBSubnetGroupName. The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetgroup`
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.
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 Amazon CloudWatch Logs.
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`
Engine	System.String	Gets and sets the property Engine. The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source
EngineVersion	System.String	Gets and sets the property EngineVersion. The version of the database engine to use for the new DB cluster.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. 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. If you do not specify a value for the `KmsKeyId` parameter, then the following will occur: If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is not encrypted, then the restored DB cluster is not encrypted.
OptionGroupName	System.String	Gets and sets the property OptionGroupName. (Not supported by Neptune)
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.
ServerlessV2ScalingConfiguration	Amazon.Neptune.Model.ServerlessV2ScalingConfiguration	Gets and sets the property ServerlessV2ScalingConfiguration. Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
SnapshotIdentifier	System.String	Gets and sets the property SnapshotIdentifier. The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot.
StorageType	System.String	Gets and sets the property StorageType. Specifies the storage type to be associated with the DB cluster. Valid values: `standard`, `iopt1` Default: `standard`
Tags	System.Collections.Generic.List<Amazon.Neptune.Model.Tag>	Gets and sets the property Tags. The tags to be assigned to the restored DB cluster.
VpcSecurityGroupIds	System.Collections.Generic.List<System.String>	Gets and sets the property VpcSecurityGroupIds. A list of VPC security groups that the new DB cluster will belong to.

Examples

The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.

To restore an Amazon Aurora DB cluster from a DB cluster snapshot


var response = client.RestoreDBClusterFromSnapshot(new RestoreDBClusterFromSnapshotRequest 
{
    DBClusterIdentifier = "restored-cluster1",
    Engine = "aurora",
    SnapshotIdentifier = "sample-cluster-snapshot1"
});

DBCluster dbCluster = response.DBCluster;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5