Amazon Neptune · JSON Structure

Management Db Cluster Structure

Contains the details of an Amazon Neptune DB cluster.

Type: object Properties: 22
DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

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

Properties

DBClusterIdentifier DBClusterArn Status Engine EngineVersion Endpoint ReaderEndpoint Port MasterUsername DBClusterParameterGroup DBSubnetGroup AllocatedStorage ClusterCreateTime PreferredBackupWindow PreferredMaintenanceWindow MultiAZ StorageEncrypted KmsKeyId DeletionProtection IAMDatabaseAuthenticationEnabled DBClusterMembers AssociatedRoles

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-cluster-structure.json",
  "name": "DBCluster",
  "description": "Contains the details of an Amazon Neptune DB cluster.",
  "type": "object",
  "properties": {
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The user-supplied DB cluster identifier."
    },
    "DBClusterArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) for the DB cluster."
    },
    "Status": {
      "type": "string",
      "description": "Current state of the cluster."
    },
    "Engine": {
      "type": "string",
      "description": "The database engine (neptune)."
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version of the database engine."
    },
    "Endpoint": {
      "type": "string",
      "description": "The connection endpoint for the primary instance."
    },
    "ReaderEndpoint": {
      "type": "string",
      "description": "The reader endpoint for read replicas."
    },
    "Port": {
      "type": "int32",
      "description": "The port that the DB cluster listens on."
    },
    "MasterUsername": {
      "type": "string",
      "description": "The master username for the cluster."
    },
    "DBClusterParameterGroup": {
      "type": "string",
      "description": "The name of the DB cluster parameter group."
    },
    "DBSubnetGroup": {
      "type": "string",
      "description": "The DB subnet group associated with the cluster."
    },
    "AllocatedStorage": {
      "type": "int32",
      "description": "The allocated storage size in gigabytes."
    },
    "ClusterCreateTime": {
      "type": "datetime",
      "description": "The time when the DB cluster was created."
    },
    "PreferredBackupWindow": {
      "type": "string",
      "description": "The daily time range for automated backups."
    },
    "PreferredMaintenanceWindow": {
      "type": "string",
      "description": "The weekly time range for system maintenance."
    },
    "MultiAZ": {
      "type": "boolean",
      "description": "Whether the cluster is Multi-AZ enabled."
    },
    "StorageEncrypted": {
      "type": "boolean",
      "description": "Whether the cluster storage is encrypted."
    },
    "KmsKeyId": {
      "type": "string",
      "description": "The KMS key identifier for encrypted clusters."
    },
    "DeletionProtection": {
      "type": "boolean",
      "description": "Whether deletion protection is enabled."
    },
    "IAMDatabaseAuthenticationEnabled": {
      "type": "boolean",
      "description": "Whether IAM database authentication is enabled."
    },
    "DBClusterMembers": {
      "type": "array",
      "description": "The list of instances in the cluster.",
      "items": {
        "$ref": "#/components/schemas/DBClusterMember"
      }
    },
    "AssociatedRoles": {
      "type": "array",
      "description": "IAM roles associated with the cluster.",
      "items": {
        "$ref": "#/components/schemas/DBClusterRole"
      }
    }
  }
}