Skip to content

Creates a Neptune global database spread across multiple Amazon Regions

Description

Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.

Usage

neptune_create_global_cluster(GlobalClusterIdentifier,
  SourceDBClusterIdentifier, Engine, EngineVersion, DeletionProtection,
  DatabaseName, Tags, StorageEncrypted)

Arguments

  • GlobalClusterIdentifier

    [required] The cluster identifier of the new global database cluster.

  • SourceDBClusterIdentifier

    (Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

  • Engine

    The name of the database engine to be used in the global database.

    Valid values: neptune

  • EngineVersion

    The Neptune engine version to be used by the global database.

    Valid values: 1.2.0.0 or above.

  • DeletionProtection

    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

  • DatabaseName

    The name for the new global database (up to 64 alpha-numeric characters).

  • Tags

    Tags to assign to the global cluster.

  • StorageEncrypted

    The storage encryption setting for the new global database cluster.

Value

A list with the following syntax:

list(
  GlobalCluster = list(
    GlobalClusterIdentifier = "string",
    GlobalClusterResourceId = "string",
    GlobalClusterArn = "string",
    Status = "string",
    Engine = "string",
    EngineVersion = "string",
    DatabaseName = "string",
    StorageEncrypted = TRUE|FALSE,
    DeletionProtection = TRUE|FALSE,
    GlobalClusterMembers = list(
      list(
        DBClusterArn = "string",
        Readers = list(
          "string"
        ),
        IsWriter = TRUE|FALSE
      )
    ),
    FailoverState = list(
      Status = "pending"|"failing-over"|"cancelling",
      FromDbClusterArn = "string",
      ToDbClusterArn = "string",
      IsDataLossAllowed = TRUE|FALSE
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$create_global_cluster(
  GlobalClusterIdentifier = "string",
  SourceDBClusterIdentifier = "string",
  Engine = "string",
  EngineVersion = "string",
  DeletionProtection = TRUE|FALSE,
  DatabaseName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  StorageEncrypted = TRUE|FALSE
)