DBCluster

Contains the details of an Amazon Neptune DB cluster.

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

Properties

Name	Type	Description
DBClusterIdentifier	string	The user-supplied DB cluster identifier.
DBClusterArn	string	The Amazon Resource Name (ARN) for the DB cluster.
Status	string	Current state of the cluster.
Engine	string	The database engine (neptune).
EngineVersion	string	The version of the database engine.
Endpoint	string	The connection endpoint for the primary instance.
ReaderEndpoint	string	The reader endpoint for read replicas.
Port	integer	The port that the DB cluster listens on.
MasterUsername	string	The master username for the cluster.
DBClusterParameterGroup	string	The name of the DB cluster parameter group.
DBSubnetGroup	string	The DB subnet group associated with the cluster.
AllocatedStorage	integer	The allocated storage size in gigabytes.
ClusterCreateTime	string	The time when the DB cluster was created.
PreferredBackupWindow	string	The daily time range for automated backups.
PreferredMaintenanceWindow	string	The weekly time range for system maintenance.
MultiAZ	boolean	Whether the cluster is Multi-AZ enabled.
StorageEncrypted	boolean	Whether the cluster storage is encrypted.
KmsKeyId	string	The KMS key identifier for encrypted clusters.
DeletionProtection	boolean	Whether deletion protection is enabled.
IAMDatabaseAuthenticationEnabled	boolean	Whether IAM database authentication is enabled.
DBClusterMembers	array	The list of instances in the cluster.
AssociatedRoles	array	IAM roles associated with the cluster.

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/management-db-cluster-schema.json",
  "title": "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": "integer",
      "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": "integer",
      "description": "The allocated storage size in gigabytes."
    },
    "ClusterCreateTime": {
      "type": "string",
      "format": "date-time",
      "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"
      }
    }
  }
}