Amazon Neptune · JSON Structure

Analytics Create Graph Input Structure

CreateGraphInput schema from Neptune

Type: object Properties: 8 Required: 2
DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

CreateGraphInput is a JSON Structure definition published by Amazon Neptune, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

graphName provisionedMemory tags publicConnectivity kmsKeyIdentifier vectorSearchConfiguration replicaCount deletionProtection

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-structure/analytics-create-graph-input-structure.json",
  "name": "CreateGraphInput",
  "description": "CreateGraphInput schema from Neptune",
  "type": "object",
  "properties": {
    "graphName": {
      "type": "string",
      "description": "The name of the graph (1-63 alphanumeric characters or hyphens).",
      "minLength": 1,
      "maxLength": 63
    },
    "provisionedMemory": {
      "type": "int32",
      "description": "The provisioned memory size in Neptune Capacity Units (NCUs)."
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Tags to assign to the graph."
    },
    "publicConnectivity": {
      "type": "boolean",
      "description": "Whether the graph can be reached over the internet.",
      "default": false
    },
    "kmsKeyIdentifier": {
      "type": "string",
      "description": "KMS key identifier for encryption at rest."
    },
    "vectorSearchConfiguration": {
      "type": "object",
      "description": "Vector search configuration for the graph.",
      "properties": {
        "dimension": {
          "type": "int32",
          "description": "The number of dimensions for vector embeddings."
        }
      }
    },
    "replicaCount": {
      "type": "int32",
      "description": "The number of read replicas.",
      "default": 0
    },
    "deletionProtection": {
      "type": "boolean",
      "description": "Whether deletion protection is enabled.",
      "default": false
    }
  },
  "required": [
    "graphName",
    "provisionedMemory"
  ]
}