Skip to content

Creates a new Amazon Neptune DB cluster

Description

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

Usage

neptune_create_db_cluster(AvailabilityZones, BackupRetentionPeriod,
  CharacterSetName, CopyTagsToSnapshot, DatabaseName, DBClusterIdentifier,
  DBClusterParameterGroupName, VpcSecurityGroupIds, DBSubnetGroupName,
  Engine, EngineVersion, Port, MasterUsername, MasterUserPassword,
  OptionGroupName, PreferredBackupWindow, PreferredMaintenanceWindow,
  ReplicationSourceIdentifier, Tags, StorageEncrypted, KmsKeyId,
  PreSignedUrl, EnableIAMDatabaseAuthentication,
  EnableCloudwatchLogsExports, DeletionProtection,
  ServerlessV2ScalingConfiguration, GlobalClusterIdentifier, StorageType,
  NetworkType)

Arguments

  • AvailabilityZones

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

  • 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

  • CharacterSetName

    (Not supported by Neptune)

  • CopyTagsToSnapshot

    If set to true, tags are copied to any snapshot of the DB cluster that is created.

  • DatabaseName

    Not supported by Neptune.

  • DBClusterIdentifier

    [required] 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

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

  • VpcSecurityGroupIds

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

  • 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

  • Engine

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

    Valid Values: neptune

  • EngineVersion

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

    Example: 1.2.1.0

  • Port

    The port number on which the instances in the DB cluster accept connections.

    Default: 8182

  • MasterUsername

    Not supported by Neptune.

  • MasterUserPassword

    Not supported by Neptune.

  • OptionGroupName

    (Not supported by Neptune)

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

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

  • ReplicationSourceIdentifier

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

  • Tags

    The tags to assign to the new DB cluster.

  • StorageEncrypted

    Specifies whether the DB cluster is encrypted.

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

  • PreSignedUrl

    This parameter is not currently supported.

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

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

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

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

  • GlobalClusterIdentifier

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

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

  • NetworkType

    The network type of the DB cluster.

    Valid Values:

    • IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication.
    • DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6.

Value

A list with the following syntax:

list(
  DBCluster = list(
    AllocatedStorage = 123,
    AvailabilityZones = list(
      "string"
    ),
    BackupRetentionPeriod = 123,
    CharacterSetName = "string",
    DatabaseName = "string",
    DBClusterIdentifier = "string",
    DBClusterParameterGroup = "string",
    DBSubnetGroup = "string",
    Status = "string",
    PercentProgress = "string",
    EarliestRestorableTime = as.POSIXct(
      "2015-01-01"
    ),
    Endpoint = "string",
    ReaderEndpoint = "string",
    MultiAZ = TRUE|FALSE,
    Engine = "string",
    EngineVersion = "string",
    LatestRestorableTime = as.POSIXct(
      "2015-01-01"
    ),
    Port = 123,
    MasterUsername = "string",
    DBClusterOptionGroupMemberships = list(
      list(
        DBClusterOptionGroupName = "string",
        Status = "string"
      )
    ),
    PreferredBackupWindow = "string",
    PreferredMaintenanceWindow = "string",
    ReplicationSourceIdentifier = "string",
    ReadReplicaIdentifiers = list(
      "string"
    ),
    DBClusterMembers = list(
      list(
        DBInstanceIdentifier = "string",
        IsClusterWriter = TRUE|FALSE,
        DBClusterParameterGroupStatus = "string",
        PromotionTier = 123
      )
    ),
    VpcSecurityGroups = list(
      list(
        VpcSecurityGroupId = "string",
        Status = "string"
      )
    ),
    HostedZoneId = "string",
    StorageEncrypted = TRUE|FALSE,
    KmsKeyId = "string",
    DbClusterResourceId = "string",
    DBClusterArn = "string",
    AssociatedRoles = list(
      list(
        RoleArn = "string",
        Status = "string",
        FeatureName = "string"
      )
    ),
    IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
    CloneGroupId = "string",
    ClusterCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    CopyTagsToSnapshot = TRUE|FALSE,
    EnabledCloudwatchLogsExports = list(
      "string"
    ),
    PendingModifiedValues = list(
      PendingCloudwatchLogsExports = list(
        LogTypesToEnable = list(
          "string"
        ),
        LogTypesToDisable = list(
          "string"
        )
      ),
      DBClusterIdentifier = "string",
      IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
      EngineVersion = "string",
      BackupRetentionPeriod = 123,
      StorageType = "string",
      AllocatedStorage = 123,
      Iops = 123,
      NetworkType = "string"
    ),
    DeletionProtection = TRUE|FALSE,
    CrossAccountClone = TRUE|FALSE,
    AutomaticRestartTime = as.POSIXct(
      "2015-01-01"
    ),
    ServerlessV2ScalingConfiguration = list(
      MinCapacity = 123.0,
      MaxCapacity = 123.0
    ),
    GlobalClusterIdentifier = "string",
    IOOptimizedNextAllowedModificationTime = as.POSIXct(
      "2015-01-01"
    ),
    StorageType = "string",
    NetworkType = "string"
  )
)

Request syntax

svc$create_db_cluster(
  AvailabilityZones = list(
    "string"
  ),
  BackupRetentionPeriod = 123,
  CharacterSetName = "string",
  CopyTagsToSnapshot = TRUE|FALSE,
  DatabaseName = "string",
  DBClusterIdentifier = "string",
  DBClusterParameterGroupName = "string",
  VpcSecurityGroupIds = list(
    "string"
  ),
  DBSubnetGroupName = "string",
  Engine = "string",
  EngineVersion = "string",
  Port = 123,
  MasterUsername = "string",
  MasterUserPassword = "string",
  OptionGroupName = "string",
  PreferredBackupWindow = "string",
  PreferredMaintenanceWindow = "string",
  ReplicationSourceIdentifier = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  StorageEncrypted = TRUE|FALSE,
  KmsKeyId = "string",
  PreSignedUrl = "string",
  EnableIAMDatabaseAuthentication = TRUE|FALSE,
  EnableCloudwatchLogsExports = list(
    "string"
  ),
  DeletionProtection = TRUE|FALSE,
  ServerlessV2ScalingConfiguration = list(
    MinCapacity = 123.0,
    MaxCapacity = 123.0
  ),
  GlobalClusterIdentifier = "string",
  StorageType = "string",
  NetworkType = "string"
)