mongodbatlas.AdvancedCluster

Type of the cluster that you want to create. Accepted values include:

Unique ID for the project to create the database user.

Configuration for cluster regions and the hardware provisioned in them. See below

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Deprecated:

use bi_connector_config instead

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Flag that indicates if the cluster uses Continuous Cloud Backup.

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

Type of the cluster that you want to create. Accepted values include:

Unique ID for the project to create the database user.

Configuration for cluster regions and the hardware provisioned in them. See below

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Deprecated:

use bi_connector_config instead

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Flag that indicates if the cluster uses Continuous Cloud Backup.

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

Type of the cluster that you want to create. Accepted values include:

Unique ID for the project to create the database user.

Configuration for cluster regions and the hardware provisioned in them. See below

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Deprecated:

use bi_connector_config instead

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Flag that indicates if the cluster uses Continuous Cloud Backup.

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

Type of the cluster that you want to create. Accepted values include:

Unique ID for the project to create the database user.

Configuration for cluster regions and the hardware provisioned in them. See below

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Deprecated:

use bi_connector_config instead

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Flag that indicates if the cluster uses Continuous Cloud Backup.

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

Type of the cluster that you want to create. Accepted values include:

Unique ID for the project to create the database user.

Configuration for cluster regions and the hardware provisioned in them. See below

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Deprecated:

use bi_connector_config instead

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Flag that indicates if the cluster uses Continuous Cloud Backup.

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

Type of the cluster that you want to create. Accepted values include:

Unique ID for the project to create the database user.

Configuration for cluster regions and the hardware provisioned in them. See below

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Deprecated:

use bi_connector_config instead

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Flag that indicates if the cluster uses Continuous Cloud Backup.

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

The cluster ID.

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

The provider-assigned unique ID for this managed resource.

Version of MongoDB the cluster runs, in major-version.minor-version format.

Current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

The cluster ID.

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

The provider-assigned unique ID for this managed resource.

Version of MongoDB the cluster runs, in major-version.minor-version format.

Current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

The cluster ID.

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

The provider-assigned unique ID for this managed resource.

Version of MongoDB the cluster runs, in major-version.minor-version format.

Current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

The cluster ID.

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

The provider-assigned unique ID for this managed resource.

Version of MongoDB the cluster runs, in major-version.minor-version format.

Current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

The cluster ID.

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

The provider-assigned unique ID for this managed resource.

Version of MongoDB the cluster runs, in major-version.minor-version format.

Current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

The cluster ID.

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

The provider-assigned unique ID for this managed resource.

Version of MongoDB the cluster runs, in major-version.minor-version format.

Current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

• Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see oplogMinRetentionHours

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

• Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see oplogMinRetentionHours

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

• Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see oplogMinRetentionHours

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

• Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see oplogMinRetentionHours

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

• Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see oplogMinRetentionHours

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

• Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see oplogMinRetentionHours

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

• Set to true to enable BI Connector for Atlas.
• Set to false to disable BI Connector for Atlas.

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Cloud service provider on which the servers are provisioned. The possible values are:

Cloud service provider on which the servers are provisioned. The possible values are:

Cloud service provider on which the servers are provisioned. The possible values are:

Cloud service provider on which the servers are provisioned. The possible values are:

Cloud service provider on which the servers are provisioned. The possible values are:

Cloud service provider on which the servers are provisioned. The possible values are:

The key that you want to write.

The value that you want to write.

The key that you want to write.

The value that you want to write.

The key that you want to write.

The value that you want to write.

The key that you want to write.

The value that you want to write.

The key that you want to write.

The value that you want to write.

The key that you want to write.

The value that you want to write.

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

Name for the zone in a Global Cluster.

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

Name for the zone in a Global Cluster.

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

Name for the zone in a Global Cluster.

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

Name for the zone in a Global Cluster.

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

Name for the zone in a Global Cluster.

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

Name for the zone in a Global Cluster.

Election priority of the region. For regions with only read-only nodes, set this value to 0.

• If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
• If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

Cloud service provider on which the servers are provisioned. The possible values are:

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling parameter must be the same for every item in the replication_specs array. See below

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Election priority of the region. For regions with only read-only nodes, set this value to 0.

• If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
• If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

Cloud service provider on which the servers are provisioned. The possible values are:

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling parameter must be the same for every item in the replication_specs array. See below

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Election priority of the region. For regions with only read-only nodes, set this value to 0.

• If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
• If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

Cloud service provider on which the servers are provisioned. The possible values are:

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling parameter must be the same for every item in the replication_specs array. See below

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Election priority of the region. For regions with only read-only nodes, set this value to 0.

• If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
• If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

Cloud service provider on which the servers are provisioned. The possible values are:

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling parameter must be the same for every item in the replication_specs array. See below

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Election priority of the region. For regions with only read-only nodes, set this value to 0.

• If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
• If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

Cloud service provider on which the servers are provisioned. The possible values are:

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling parameter must be the same for every item in the replication_specs array. See below

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Election priority of the region. For regions with only read-only nodes, set this value to 0.

• If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
• If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

Cloud service provider on which the servers are provisioned. The possible values are:

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling parameter must be the same for every item in the replication_specs array. See below

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are: