Amazon Web ServicesDatabaseDocument DatabaseDocumentDBManaged DatabaseMongoDBNoSQL
DBCluster is a JSON Structure definition published by Amazon DocumentDB, describing 14 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-documentdb/refs/heads/main/json-structure/documentdb-openapi-db-cluster-structure.json",
"name": "DBCluster",
"description": "DBCluster schema from Amazon DocumentDB API",
"type": "object",
"properties": {
"DBClusterIdentifier": {
"type": "string",
"description": "The identifier of the DB cluster."
},
"DBClusterArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) for the DB cluster."
},
"Status": {
"type": "string",
"description": "Specifies the current state of this DB cluster."
},
"Engine": {
"type": "string",
"description": "The database engine used for this DB cluster."
},
"EngineVersion": {
"type": "string",
"description": "The version of the database engine."
},
"Endpoint": {
"type": "string",
"description": "The connection endpoint for the primary instance of the DB cluster."
},
"ReaderEndpoint": {
"type": "string",
"description": "The reader endpoint for the DB cluster."
},
"Port": {
"type": "int32",
"description": "The port that the database engine is listening on."
},
"MasterUsername": {
"type": "string",
"description": "The master username for the DB cluster."
},
"DBSubnetGroup": {
"type": "string",
"description": "The DB subnet group associated with the DB cluster."
},
"StorageEncrypted": {
"type": "boolean",
"description": "Specifies whether the DB cluster is encrypted."
},
"BackupRetentionPeriod": {
"type": "int32",
"description": "The number of days for which automatic DB snapshots are retained."
},
"ClusterCreateTime": {
"type": "datetime",
"description": "The time when the DB cluster was created."
},
"DBClusterMembers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DBInstanceIdentifier": {
"type": "string"
},
"IsClusterWriter": {
"type": "boolean"
}
}
},
"description": "The list of instances that make up the DB cluster."
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.