Amazon DocumentDB · Schema
Amazon DocumentDB DBCluster
Schema representing an Amazon DocumentDB database cluster, which is a managed MongoDB-compatible document database cluster consisting of one or more instances connected to a shared storage volume.
Amazon Web ServicesAWSDatabaseDocument DatabaseDocumentDBManaged DatabaseMongoDBNoSQL
Properties
| Name | Type | Description |
|---|---|---|
| DBClusterIdentifier | string | The user-supplied DB cluster identifier. This identifier is the unique key that identifies a 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 name of the database engine to be used for this DB cluster. |
| EngineVersion | string | Indicates the database engine version. |
| Endpoint | string | The connection endpoint for the primary instance of the DB cluster. |
| ReaderEndpoint | string | The reader endpoint for the DB cluster. The reader endpoint load-balances connections across the read replicas. |
| Port | integer | Specifies the port that the database engine is listening on. |
| MasterUsername | string | Contains the master username for the DB cluster. |
| DBSubnetGroup | string | Specifies information on the subnet group associated with the DB cluster. |
| StorageEncrypted | boolean | Specifies whether the DB cluster is encrypted. |
| KmsKeyId | string | If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster. |
| BackupRetentionPeriod | integer | Specifies the number of days for which automatic DB snapshots are retained. |
| PreferredBackupWindow | string | Specifies the daily time range during which automated backups are created. |
| PreferredMaintenanceWindow | string | Specifies the weekly time range during which system maintenance can occur. |
| ClusterCreateTime | string | Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). |
| DBClusterMembers | array | Provides the list of instances that make up the DB cluster. |
| VpcSecurityGroups | array | Provides a list of VPC security groups that the DB cluster belongs to. |
| DeletionProtection | boolean | Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. |
| EnabledCloudwatchLogsExports | array | A list of log types that this DB cluster is configured to export to Amazon CloudWatch Logs. |