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 3.5
 
Container for the parameters to the RestoreDBClusterFromSnapshot operation. Creates a new DB cluster from a DB cluster snapshot. 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.

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

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

Syntax

C#
public class RestoreDBClusterFromSnapshotRequest : AmazonRDSRequest
         IRequestEvents

The RestoreDBClusterFromSnapshotRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property 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.

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

The database name for the restored DB cluster.

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

The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

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

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

Public Property 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

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

The version of the database engine 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 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 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.

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

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

If SnapshotIdentifier refers to a DB cluster snapshot that is not encrypted, and you specify a value for the KmsKeyId parameter, then the restore request is rejected.

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

The name of the option group to use for the restored 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 SnapshotIdentifier System.String Gets and sets the property SnapshotIdentifier.

The identifier for the DB cluster snapshot to restore from.

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 Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag> Gets and sets the property Tags.

The tags to be assigned to the restored DB cluster.

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 will belong 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