Amazon DocumentDB · Schema
DBCluster
DBCluster schema from Amazon DocumentDB API
Amazon Web ServicesDatabaseDocument DatabaseDocumentDBManaged DatabaseMongoDBNoSQL
Properties
| Name | Type | Description |
|---|---|---|
| DBClusterIdentifier | string | The identifier of the DB cluster. |
| DBClusterArn | string | The Amazon Resource Name (ARN) for the DB cluster. |
| Status | string | Specifies the current state of this DB cluster. |
| Engine | string | The database engine used for this DB cluster. |
| EngineVersion | string | The version of the database engine. |
| Endpoint | string | The connection endpoint for the primary instance of the DB cluster. |
| ReaderEndpoint | string | The reader endpoint for the DB cluster. |
| Port | integer | The port that the database engine is listening on. |
| MasterUsername | string | The master username for the DB cluster. |
| DBSubnetGroup | string | The DB subnet group associated with the DB cluster. |
| StorageEncrypted | boolean | Specifies whether the DB cluster is encrypted. |
| BackupRetentionPeriod | integer | The number of days for which automatic DB snapshots are retained. |
| ClusterCreateTime | string | The time when the DB cluster was created. |
| DBClusterMembers | array | The list of instances that make up the DB cluster. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-documentdb/refs/heads/main/json-schema/documentdb-openapi-db-cluster-schema.json",
"title": "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": "integer",
"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": "integer",
"description": "The number of days for which automatic DB snapshots are retained."
},
"ClusterCreateTime": {
"type": "string",
"format": "date-time",
"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."
}
}
}