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 CreateDBCluster operation. Creates a new Amazon Neptune DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.

Inheritance Hierarchy

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

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

Syntax

C# 
public class CreateDBClusterRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest, IPreSignedUrlRequest

The CreateDBClusterRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDBClusterRequest()

Properties

NameTypeDescription
Public Property AvailabilityZones System.Collections.Generic.List<System.String>

Gets and sets the property AvailabilityZones.

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

Public Property BackupRetentionPeriod System.Int32

Gets and sets the property BackupRetentionPeriod.

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Public Property CharacterSetName System.String

Gets and sets the property CharacterSetName.

(Not supported by Neptune)
Public Property CopyTagsToSnapshot System.Boolean

Gets and sets the property CopyTagsToSnapshot.

If set to true, tags are copied to any snapshot of the DB cluster that is created.
Public Property DatabaseName System.String

Gets and sets the property DatabaseName.

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

Public Property DBClusterIdentifier System.String

Gets and sets the property DBClusterIdentifier.

The DB cluster identifier. This parameter is stored as a lowercase string.

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-cluster1
Public Property DBClusterParameterGroupName System.String

Gets and sets the property DBClusterParameterGroupName.

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

Constraints:

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

Public Property DBSubnetGroupName System.String

Gets and sets the property DBSubnetGroupName.

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

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

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

Gets and sets the property EnableCloudwatchLogsExports.

A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

Public Property EnableIAMDatabaseAuthentication System.Boolean

Gets and sets the property EnableIAMDatabaseAuthentication.

If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

Default: false.

Public Property Engine System.String

Gets and sets the property Engine.

The name of the database engine to be used for this DB cluster.

Valid Values: neptune
Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

The version number of the database engine to use for the new DB cluster.

Example: 1.2.1.0
Public Property GlobalClusterIdentifier System.String

Gets and sets the property GlobalClusterIdentifier.

The ID of the Neptune global database to which this new DB cluster should be added.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The Amazon KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating 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 an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

Not supported by Neptune.

Public Property MasterUserPassword System.String

Gets and sets the property MasterUserPassword.

Not supported by Neptune.

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 instances in the DB cluster accept connections.

Default: 8182
Public Property PreferredBackupWindow System.String

Gets and sets the property PreferredBackupWindow.

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Public Property PreSignedUrl System.String

Gets and sets the property PreSignedUrl.

This parameter is not currently supported.

Public Property ReplicationSourceIdentifier System.String

Gets and sets the property ReplicationSourceIdentifier.

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

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

Public Property SourceRegion System.String

The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client.

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Specifies whether the DB cluster is encrypted.

Public Property StorageType System.String

Gets and sets the property StorageType.

The storage type for the new DB cluster.

Valid Values:

  • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response.

  • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

    Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

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

Gets and sets the property Tags.

The tags to assign to the new DB cluster.

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

Gets and sets the property VpcSecurityGroupIds.

A list of EC2 VPC security groups to associate with this DB cluster.

Examples

This example creates a DB cluster.

To create a DB cluster


var response = client.CreateDBCluster(new CreateDBClusterRequest 
{
    AvailabilityZones = new List<string> {
        "us-east-1a"
    },
    BackupRetentionPeriod = 1,
    DBClusterIdentifier = "mydbcluster",
    DBClusterParameterGroupName = "mydbclusterparametergroup",
    DatabaseName = "myauroradb",
    Engine = "aurora",
    EngineVersion = "5.6.10a",
    MasterUserPassword = "mypassword",
    MasterUsername = "myuser",
    Port = 3306,
    StorageEncrypted = true
});

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