

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

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.

## Request Parameters
<a name="API_RestoreDBClusterFromSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **AvailabilityZones.AvailabilityZone.N**   
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.  
Type: Array of strings  
Required: No

 ** CopyTagsToSnapshot **   
 *If set to `true`, tags are copied to any snapshot of the restored DB cluster that is created.*   
Type: Boolean  
Required: No

 ** DatabaseName **   
Not supported.  
Type: String  
Required: No

 ** 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`   
Type: String  
Required: Yes

 ** 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.
Type: String  
Required: No

 ** 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`   
Type: String  
Required: No

 ** 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.   
Type: Boolean  
Required: No

 **EnableCloudwatchLogsExports.member.N**   
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.  
Type: Array of strings  
Required: No

 ** EnableIAMDatabaseAuthentication **   
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.  
Default: `false`   
Type: Boolean  
Required: No

 ** 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  
Type: String  
Required: Yes

 ** EngineVersion **   
The version of the database engine to use for the new DB cluster.  
Type: String  
Required: No

 ** 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.
Type: String  
Required: No

 ** OptionGroupName **   
 *(Not supported by Neptune)*   
Type: String  
Required: No

 ** 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.  
Type: Integer  
Required: No

 ** ServerlessV2ScalingConfiguration **   
Contains the scaling configuration of a Neptune Serverless DB cluster.  
For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*.  
Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object  
Required: No

 ** 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.
Type: String  
Required: Yes

 ** StorageType **   
Specifies the storage type to be associated with the DB cluster.  
Valid values: `standard`, `iopt1`   
Default: `standard`   
Type: String  
Required: No

 **Tags.Tag.N**   
The tags to be assigned to the restored DB cluster.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
A list of VPC security groups that the new DB cluster will belong to.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** DBCluster **   
Contains the details of an Amazon Neptune DB cluster.  
This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md).  
Type: [DBCluster](API_DBCluster.md) object

## Errors
<a name="API_RestoreDBClusterFromSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
User already has a DB cluster with the given identifier.  
HTTP Status Code: 400

 ** DBClusterParameterGroupNotFound **   
 *DBClusterParameterGroupName* does not refer to an existing DB Cluster parameter group.  
HTTP Status Code: 404

 ** DBClusterQuotaExceededFault **   
User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.  
HTTP Status Code: 403

 ** DBClusterSnapshotNotFoundFault **   
 *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot.  
HTTP Status Code: 404

 ** DBSnapshotNotFound **   
 *DBSnapshotIdentifier* does not refer to an existing DB snapshot.  
HTTP Status Code: 404

 ** DBSubnetGroupNotFoundFault **   
 *DBSubnetGroupName* does not refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** DBSubnetGroupNotFoundFault **   
 *DBSubnetGroupName* does not refer to an existing DB subnet group.  
HTTP Status Code: 404

 ** InsufficientDBClusterCapacityFault **   
The DB cluster does not have enough capacity for the current operation.  
HTTP Status Code: 403

 ** InsufficientStorageClusterCapacity **   
There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.  
HTTP Status Code: 400

 ** InvalidDBClusterSnapshotStateFault **   
The supplied value is not a valid DB cluster snapshot state.  
HTTP Status Code: 400

 ** InvalidDBSnapshotState **   
The state of the DB snapshot does not allow deletion.  
HTTP Status Code: 400

 ** InvalidRestoreFault **   
Cannot restore from vpc backup to non-vpc DB instance.  
HTTP Status Code: 400

 ** InvalidSubnet **   
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
DB subnet group does not cover all Availability Zones after it is created because users' change.  
HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
Error accessing KMS key.  
HTTP Status Code: 400

 ** OptionGroupNotFoundFault **   
The designated option group could not be found.  
HTTP Status Code: 404

 ** StorageQuotaExceeded **   
Request would result in user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

 ** StorageQuotaExceeded **   
Request would result in user exceeding the allowed amount of storage available across all DB instances.  
HTTP Status Code: 400

## See Also
<a name="API_RestoreDBClusterFromSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) 