CreateGraphInput

CreateGraphInput schema from Neptune

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

Properties

Name	Type	Description
graphName	string	The name of the graph (1-63 alphanumeric characters or hyphens).
provisionedMemory	integer	The provisioned memory size in Neptune Capacity Units (NCUs).
tags	object	Tags to assign to the graph.
publicConnectivity	boolean	Whether the graph can be reached over the internet.
kmsKeyIdentifier	string	KMS key identifier for encryption at rest.
vectorSearchConfiguration	object	Vector search configuration for the graph.
replicaCount	integer	The number of read replicas.
deletionProtection	boolean	Whether deletion protection is enabled.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-schema/analytics-create-graph-input-schema.json",
  "title": "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": "integer",
      "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": "integer",
          "description": "The number of dimensions for vector embeddings."
        }
      }
    },
    "replicaCount": {
      "type": "integer",
      "description": "The number of read replicas.",
      "default": 0
    },
    "deletionProtection": {
      "type": "boolean",
      "description": "Whether deletion protection is enabled.",
      "default": false
    }
  },
  "required": [
    "graphName",
    "provisionedMemory"
  ]
}