Amazon Neptune · JSON Structure

Management Db Instance Structure

Contains the details of an Amazon Neptune DB instance.

Type: object Properties: 14
DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

DBInstance is a JSON Structure definition published by Amazon Neptune, describing 14 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DBInstanceIdentifier DBInstanceClass Engine DBInstanceStatus Endpoint DBClusterIdentifier AvailabilityZone PreferredMaintenanceWindow EngineVersion AutoMinorVersionUpgrade PubliclyAccessible DBInstanceArn PromotionTier StorageEncrypted

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/management-db-instance-structure.json",
  "name": "DBInstance",
  "description": "Contains the details of an Amazon Neptune DB instance.",
  "type": "object",
  "properties": {
    "DBInstanceIdentifier": {
      "type": "string",
      "description": "The user-supplied database identifier."
    },
    "DBInstanceClass": {
      "type": "string",
      "description": "The compute and memory capacity of the instance."
    },
    "Engine": {
      "type": "string",
      "description": "The database engine (neptune)."
    },
    "DBInstanceStatus": {
      "type": "string",
      "description": "Current state of the instance."
    },
    "Endpoint": {
      "type": "object",
      "properties": {
        "Address": {
          "type": "string"
        },
        "Port": {
          "type": "int32"
        }
      }
    },
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The cluster this instance belongs to."
    },
    "AvailabilityZone": {
      "type": "string",
      "description": "The Availability Zone of the instance."
    },
    "PreferredMaintenanceWindow": {
      "type": "string",
      "description": "The weekly time range for system maintenance."
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version of the database engine."
    },
    "AutoMinorVersionUpgrade": {
      "type": "boolean",
      "description": "Whether minor version upgrades are applied automatically."
    },
    "PubliclyAccessible": {
      "type": "boolean",
      "description": "Whether the instance is publicly accessible."
    },
    "DBInstanceArn": {
      "type": "string",
      "description": "The ARN of the DB instance."
    },
    "PromotionTier": {
      "type": "int32",
      "description": "The failover priority for the instance."
    },
    "StorageEncrypted": {
      "type": "boolean",
      "description": "Whether the instance storage is encrypted."
    }
  }
}