> For the complete documentation index, see [llms.txt](https://docs.ionos.com/mongodb-sdk-ruby/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/mongodb-sdk-ruby/models/clusterproperties.md).

# ClusterProperties

## Properties

| Name                    | Type                                                                   | Description                                                                                                                                                                                                                                                                      | Notes       |
| ----------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **display\_name**       | **String**                                                             | The name of your cluster.                                                                                                                                                                                                                                                        | \[optional] |
| **mongo\_db\_version**  | **String**                                                             | The MongoDB version of your cluster.                                                                                                                                                                                                                                             | \[optional] |
| **location**            | **String**                                                             | The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.                                                                                                                              | \[optional] |
| **instances**           | **Integer**                                                            | The total number of instances in the cluster (one primary and n-1 secondaries).                                                                                                                                                                                                  | \[optional] |
| **connections**         | [**Array\<Connection>**](/mongodb-sdk-ruby/models/connection.md)       |                                                                                                                                                                                                                                                                                  | \[optional] |
| **maintenance\_window** | [**MaintenanceWindow**](/mongodb-sdk-ruby/models/maintenancewindow.md) |                                                                                                                                                                                                                                                                                  | \[optional] |
| **template\_id**        | **String**                                                             | The unique ID of the template, which specifies the number of cores, storage size, and memory. You cannot downgrade to a smaller template or minor edition (e.g. from business to playground). To get a list of all templates to confirm the changes use the /templates endpoint. | \[optional] |
| **connection\_string**  | **String**                                                             | The connection string for your cluster.                                                                                                                                                                                                                                          | \[optional] |

## Example

```ruby
require 'ionoscloud-dbaas-mongo'

instance = IonoscloudDbaasMongo::ClusterProperties.new(
  display_name: MongoDB cluster,
  mongo_db_version: 5.0,
  location: de/txl,
  instances: 3,
  connections: null,
  maintenance_window: null,
  template_id: 498ae72f-411f-11eb-9d07-046c59cc737e,
  connection_string: mongo+srv://m-498ae72f-411f-11eb-9d07-046c59cc737e.mongodb.de-txl.ionos.com
)
```
