Represents a Neptune Analytics graph resource, which is a memory-optimized graph database instance for analytical workloads with support for openCypher queries, vector search, and optimized graph algorithms.
Amazon Neptune Analytics Graph is a JSON Structure definition published by Amazon Neptune, describing 17 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://github.com/api-search/amazon-neptune/json-structure/amazon-neptune-analytics-graph-structure.json",
"name": "Amazon Neptune Analytics Graph",
"description": "Represents a Neptune Analytics graph resource, which is a memory-optimized graph database instance for analytical workloads with support for openCypher queries, vector search, and optimized graph algorithms.",
"type": "object",
"required": [
"graphName",
"provisionedMemory"
],
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the graph, assigned by Neptune Analytics."
},
"name": {
"type": "string",
"description": "The name of the graph.",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-zA-Z][a-zA-Z0-9-]*$"
},
"graphName": {
"type": "string",
"description": "The name of the graph (used in creation requests).",
"minLength": 1,
"maxLength": 63
},
"arn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the graph."
},
"status": {
"type": "string",
"description": "The current status of the graph resource.",
"enum": [
"CREATING",
"AVAILABLE",
"DELETING",
"RESETTING",
"UPDATING",
"SNAPSHOTTING",
"FAILED",
"IMPORTING"
]
},
"statusReason": {
"type": "string",
"description": "The reason for the current status, if applicable."
},
"createTime": {
"type": "datetime",
"description": "The time the graph was created."
},
"provisionedMemory": {
"type": "int32",
"description": "The provisioned memory size in Neptune Capacity Units (NCUs). Each NCU provides approximately 2 GiB of memory.",
"minimum": 16
},
"endpoint": {
"type": "string",
"description": "The DNS endpoint for connecting to the graph."
},
"publicConnectivity": {
"type": "boolean",
"description": "Whether the graph can be accessed over the public internet.",
"default": false
},
"vectorSearchConfiguration": {
"type": "object",
"description": "Configuration for vector search capabilities.",
"properties": {
"dimension": {
"type": "int32",
"description": "The number of dimensions for vector embeddings.",
"minimum": 1
}
}
},
"replicaCount": {
"type": "int32",
"description": "The number of read replicas for the graph.",
"minimum": 0,
"default": 0
},
"kmsKeyIdentifier": {
"type": "string",
"description": "The KMS key identifier used for encryption at rest."
},
"sourceSnapshotId": {
"type": "string",
"description": "The ID of the source snapshot if the graph was restored from a snapshot."
},
"deletionProtection": {
"type": "boolean",
"description": "Whether deletion protection is enabled for the graph.",
"default": false
},
"buildNumber": {
"type": "string",
"description": "The build number of the Neptune Analytics engine."
},
"tags": {
"type": "object",
"description": "Tags assigned to the graph as key-value pairs.",
"additionalProperties": {
"type": "string"
}
}
}
}