Navigation

Create One Cluster

Info With Circle IconCreated with Sketch.Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Info With Circle IconCreated with Sketch.Note

This feature is not available for M0 (Free Tier) clusters. For more information, see Atlas M0 (Free Tier) Limitations.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

  • For a given region in an Atlas project with multi-region clusters or clusters in multiple regions, there is a limit of 40 MongoDB nodes on all other regions in that project. This limit applies across all cloud service providers and can be raised upon request. GCP regions communicating with each other do not count against this limit.
    Beaker IconExample
    If an Atlas project has:
    • 30 nodes in Region A
    • 10 nodes in Region B
    • 5 nodes in Region C
    You can no longer add any nodes to your project in Region A or Region B. This is because the nodes in those clusters add up to 40, which is the maximum allowed per project. You can add up to 5 nodes in Region C while still satisfying the project limit.
    This limit applies even if Regions A, B, and C are backed by different cloud service providers.For Atlas projects where every cluster is deployed to a single region, you cannot create a multi-region cluster in that project if there are already 40 or more nodes in that single region unless you request that the limit be raised.Please contact Atlas support for questions or assistance with raising this limit.
  • If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you must delete that role before creating clusters with an earlier MongoDB version.
  • Atlas clusters created after July 2020 use Transport Layer Security (TLS ) protocol version 1.2 by default.
  • When you create a cluster, Atlas creates a network container in the project for the cloud provider to which you deploy the cluster if one does not already exist.

To use this resource, your API Key must have either the Organization Owner or Project Owner roles.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

POST /groups/{GROUP-ID}/clusters
Path ElementTypeNecessityDescription
PROJECT-IDstringRequired

Unique identifier for the project in which to create the cluster.

Each Atlas project supports up to 25 clusters. Please contact Atlas support for questions or assistance regarding the cluster limit. To contact support, select Support from the left-hand navigation bar of the Atlas UI.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

NameTypeNecessityDescriptionDefault
prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false
envelopebooleanOptional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

statusHTTP response code
envelopeExpected response body
false
Body ParameterTypeNecessityDescription
autoScalingobjectOptional

Collection of settings that configures auto-scaling information for the cluster.

If you specify the autoScaling object, you must also specify the providerSettings.autoScaling object.

Bulb IconTip
See Also:
autoScaling.autoIndexingEnabledbooleanOptional

Flag that indicates whether autopilot mode for Performance Advisor is enabled. The default is false.

Important With Circle IconCreated with Sketch.Important

Autopilot mode is only available if you are enrolled in the Auto Pilot Early Access program.

autoScaling.computeobjectOptional

Collection of settings that configure how a cluster might scale its cluster tier and whether the cluster can scale down.

Important With Circle IconCreated with Sketch.Important

Cluster tier auto-scaling is not available for clusters using Low CPU or NVME storage classes.

autoScaling.compute.enabledbooleanOptional

Flag that indicates whether cluster tier auto-scaling is enabled. The default is false.

  • Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize.
  • Set to false to disable cluster tier auto-scaling.
autoScaling.compute.scaleDownEnabledbooleanConditional

Flag that indicates whether the cluster tier may scale down. Atlas requires this parameter if "autoScaling.compute.enabled" : true.

If you enable this option, specify a value for providerSettings.autoScaling.compute.minInstanceSize.

autoScaling.diskGBEnabledbooleanOptional

Flag that indicates whether disk auto-scaling is enabled. The default is true.

  • Set to true to enable disk auto-scaling.
  • Set to false to disable disk auto-scaling.
Info With Circle IconCreated with Sketch.Note

Disk auto-scaling is subject to limitations based on the maximum amount of RAM for the selected cluster tier and the oplog size. See Customize Your Storage for details.

backupEnabledbooleanOptional

Flag that indicates whether legacy backups have been enabled.

Applicable only for M10+ clusters.

Important With Circle IconCreated with Sketch.Important

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backups: providerBackupEnabled

If you create a new Atlas cluster and set "backupEnabled" : true, the API responds with an error.

This change doesn't affect existing clusters that use legacy backups.

Set to true to enable Atlas legacy backups for the cluster.

Set to false to disable legacy backups for the cluster. Atlas deletes any stored snapshots.

To learn more about snapshot storage, see the legacy backup Snapshot Schedule.

You can't enable legacy backups if you have an existing cluster in the project with Cloud Backups enabled.

The default value is false.

biConnectorobjectOptional

Configuration of 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.

biConnector.enabledbooleanOptional

Flag that indicates whether or not BI Connector for Atlas is enabled on the cluster.

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

Source from which the BI Connector for Atlas reads data. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options.

ValueDescription
primaryBI Connector for Atlas reads data from the primary.
secondaryBI Connector for Atlas reads data from a secondary. The preference defaults to this value if there are no analytics nodes in the cluster.
analyticsBI Connector for Atlas reads data from an analytics node. Default if the cluster contains analytics nodes.
Info With Circle IconCreated with Sketch.Note

To set the readPreference value to "analytics", the cluster must have at least one analytics node.

If the readPreference value is "analytics", you cannot remove all analytics nodes from the cluster.

clusterTypestringConditional

Type of the cluster that you want to create.

Info With Circle IconCreated with Sketch.Note
When should you use clusterType?
ConditionNecessity
You set replicationSpecs.Required
You are deploying Global Clusters.Required
You are deploying non-Global replica sets and sharded clusters.Optional

Atlas accepts:

ValueCluster Type
REPLICASETreplica set
SHARDEDsharded cluster
GEOSHARDEDglobal cluster
diskSizeGBnumberConditional

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 integer.

Info With Circle IconCreated with Sketch.Note
When should you use diskSizeGB?

This setting:

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.

Important With Circle IconCreated with Sketch.Important

Atlas calculates storage charges differently depending on whether you choose the default value or a custom value.

Bulb IconTip
See Also:
Info With Circle IconCreated with Sketch.Note

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.

encryptionAtRestProviderstringOptional

Cloud service provider that offers Encryption at Rest.

Specify AWS to enable Encryption at Rest using the Atlas project AWS Key Management System settings. The cluster must meet the following requirements:

ParameterRequirement
providerSettings.instanceSizeNameM10 or greater
backupEnabledfalse or omitted

You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project.

labelsarray of objectsOptional

Collection of key-value pairs that tag and categorize the cluster.

Each key and value has a maximum length of 255 characters.

"labels": [
{
"key": "example key",
"value": "example value"
}
]
Info With Circle IconCreated with Sketch.Note

The Atlas console doesn't display your labels. Atlas returns them in the response body when you use the Atlas API to

mongoDBMajorVersionstringOptional

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:

  • 3.6
  • 4.0
  • 4.2
  • 4.4

You must set this value to 4.4 if "providerSettings.instanceSizeName" : "M2" or "M5".

Info With Circle IconCreated with Sketch.Note
MongoDB 4.4 on Shared Tier Clusters

You can deploy MongoDB 4.4 in Atlas free and shared-tier clusters (M0, M2 and M5) only in AWS region us-east-1.

Atlas always deploys the cluster with the latest stable release of the specified version. You can upgrade to a newer version of MongoDB when you modify a cluster.

namestringRequiredName of the cluster as it appears in Atlas. After Atlas creates the cluster, you can't change its name.
numShardsnumberConditional

Positive integer that specifies the number of shards to deploy for a sharded cluster.

Important With Circle IconCreated with Sketch.Important

If you use the replicationSpecs parameter, you must set numShards.

Atlas accepts 1 through 50, inclusive. The default value is 1.

  • If you specify a numShards value of 1 and a clusterType of SHARDED, Atlas deploys a single-shard sharded cluster.
  • If you specify a numShards value of 1 and a clusterType of REPLICASET, Atlas deploys a replica set.
Info With Circle IconCreated with Sketch.Note

A sharded cluster with a single shard is not recommended for production environments. Single-shard sharded clusters do not provide the same high availability and horizontal scaling benefits as configurations with multiple shards.

Bulb IconTip
Info With Circle IconCreated with Sketch.Note

Don't include in the request body for Global Clusters.

pitEnabledbooleanOptional

Flag that indicates the cluster uses continuous cloud backups.

providerBackupEnabledbooleanOptional

Applicable only for M10+ clusters.

Flag that indicates if the cluster uses Cloud Backups for backups.

  • If true, the cluster uses Cloud Backups for backups.
  • If "providerBackupEnabled" : false and "backupEnabled" : false, the cluster doesn't use Atlas backups.

You cannot enable Cloud Backups if you have an existing cluster in the project with Legacy Backups enabled.

Important With Circle IconCreated with Sketch.Important

You must set this value to true for NVMe clusters.

providerSettingsobjectRequiredConfiguration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider.
providerSettings.autoScalingobjectConditional

Range of instance sizes to which your cluster can scale.

Important With Circle IconCreated with Sketch.Important

You can't specify the providerSettings.autoScaling object if "autoScaling.compute.enabled" : false.

providerSettings.autoScaling.computeobjectConditionalRange of instance sizes to which your cluster can scale. Atlas requires this parameter if "autoScaling.compute.enabled" : true.
providerSettings.autoScaling.compute.minInstanceSizestringConditionalMinimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if "autoScaling.compute.scaleDownEnabled" : true.
providerSettings.autoScaling.compute.maxInstanceSizestringConditionalMaximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if "autoScaling.compute.enabled" : true.
providerSettings.backingProviderNamestringConditional

Cloud service provider on which the host for a multi-tenant cluster is provisioned.

This setting only works when "providerSetting.providerName" : "TENANT" and "providerSetting.instanceSizeName" : M2 or M5.

Atlas accepts the following values:

Atlas accepts:

AWSAmazon AWS
GCPGoogle Cloud Platform
AZUREMicrosoft Azure
providerSettings.diskIOPSnumberConditional

Disk IOPS setting for AWS storage. Set only if you selected AWS as your cloud service provider.

Maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

This setting requires that providerSettings.instanceSizeName to be M30 or greater and cannot be used with clusters with local NVMe SSDs.

To view the possible range of IOPS values for the selected instance size and storage capacity:

  1. Open the Atlas web interface.
  2. Select Build a New Cluster.
  3. Under Cloud Provider & Region, select AWS.
  4. Under Cloud Provider & Region, select the region corresponding to your configured providerSettings.regionName.
  5. Under Cluster Tier, select the cluster tier corresponding to your configured providerSettings.instanceSizeName.
  6. Under Cluster Tier, set the Storage Capacity slider to your configured diskSizeGB. Alternatively, input the exact value of diskSizeGB in the input box to the right of the slider.

You can see the available IOPS range by checking the Provision IOPS box.

Info With Circle IconCreated with Sketch.Note

If you set the diskIOPS value to a value higher than the default value for the selected volume size, Atlas automatically sets providerSettings.volumeType to PROVISIONED. If you manually set diskIOPS to the default value, you must specify providerSettings.volumeType to be either PROVISIONED or STANDARD.

The default value for providerSettings.diskIOPS is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas interface.

Changing this value affects the cost of running the cluster as described in the billing documentation.

Atlas enforces the following minimum ratios for given cluster tiers. This keeps cluster performance consistent with large datasets.

TierRatio of Disk Capacity : System Memory
M10 - M4060:1
=> M50120:1
Beaker IconExample

To support 3 TB (or 3,072 GB) of disk capacity, select a cluster tier with a minimum of 32 GB of RAM. This would be M50 or greater.

providerSettings.diskTypeNamestringConditional

Type of disk if you selected Azure as your cloud service provider.

Disk type of the server's root volume for Azure instances. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName.

The following table lists the possible values for this field, and their corresponding storage size.

diskTypeNameStorage Size
P2 18GB
P316GB
P4 232GB
P664GB
P10 3128GB
P15256GB
P20512GB
P301024GB
P402048GB
P504095GB

1 Default for M10 Azure clusters

2 Default for M20 and M30 Azure clusters

3 Default for M40+ Azure clusters

providerSettings.encryptEBSVolumebooleanConditional

Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster.

Info With Circle IconCreated with Sketch.Note

This setting is always enabled for clusters with local NVMe SSDs.

The default value is true.

providerSettings.instanceSizeNamestringRequired

Atlas provides different cluster tiers, each with a default storage capacity and RAM size. The cluster you select is used for all the data-bearing hosts in your cluster tier.

Bulb IconTip
See Also:
Important With Circle IconCreated with Sketch.Important

If you are deploying a Global Cluster, you must choose a cluster tier of M30 or larger.

Instance SizeDefault StorageDefault RAM
M22 GBShared
M55 GBShared
M1010 GB2 GB
M2020 GB4 GB
M3040 GB8 GB
M4080 GB16 GB
M40 Low-CPU (R40)80 GB16 GB
M40_NVME380 GB15.25 GB
M50160 GB32 GB
M50 Low-CPU (R50)160 GB32 GB
M50_NVME760 GB30.5 GB
M60320 GB64 GB
M60 Low-CPU (R60)320 GB64 GB
M60_NVME1.6 TB61 GB
M80760 GB131 GB
M80 Low-CPU (R80)750 GB122 GB
M80_NVME1.6 TB122 GB
M1001 TB160 GB
M140 11 TB192 GB
M2001.5 TB256 GB
M200 Low-CPU (R200)1.5 TB256 GB
M200_NVME3.1 TB244 GB
M300 12 TB384 GB
M300 Low-CPU (R300)2 TB384 GB
M400 Low-CPU (R400)3 TB488 GB
M400_NVME 24 TB512 GB
M700 Low-CPU (R700)4 TB768 GB

1 Unavailable in the AP_SOUTHEAST_2 region.

2 Availability limited to the following regions:

  • US_EAST_1
  • US_EAST_2
  • US_WEST_2
  • EU_WEST_1
  • EU_CENTRAL_1
  • AP_NORTHEAST_1

Atlas supports the following cluster tiers. Atlas supports deploying M2 and M5 tiers into a subset of available regions. The documentation for providersettings.regionName includes a list of these regions.

Info With Circle IconCreated with Sketch.Note
Cluster Tier Naming Conventions

Cluster tier names that are:

  • Appended with _NVME (M40_NVME for example) use direct attached NVMe storage for exceptional performance with the most I/O-intensive workloads.
  • Prepended with R instead of an M (R40 for example) run a low CPU version of the cluster.
Important With Circle IconCreated with Sketch.Important

M2 and M5 clusters are multi-tenant deployments. You must set providerSettings.providerName to TENANT and specify the cloud service provider in providerSettings.backingProviderName.

providerSettings.providerNamestringRequired

Cloud service provider on which Atlas provisions the hosts.

AWSAmazon AWS
GCPGoogle Cloud Platform
AZUREMicrosoft Azure
TENANT

M2 or M5 multi-tenant cluster.

See providerSettings.backingProviderName for the cloud service provider where Atlas provisioned the host serving the cluster.

Important With Circle IconCreated with Sketch.Important

M2 and M5 clusters are multi-tenant deployments. You must set providerSettings.providerName to TENANT and specify the cloud service provider in providerSettings.backingProviderName.

providerSettings.regionNamestringConditional
Info With Circle IconCreated with Sketch.Note
Required if replicationSpecs array is empty

If you haven't set values in the replicationSpecs array, you must set this parameter.

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases.

Don't specify this parameter when creating a multi-region cluster using the replicationSpec object or a Global Cluster with the replicationSpecs array.

During deployment of an M10+ dedicated paid cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.

For clusters deployed on AWS , if you want to create a VPC peering connection to an AWS VPC and require a specific CIDR block for a given region, you must create a VPC connection before deploying the cluster. See Set up a Network Peering Connection for for complete documentation on VPC peering connections.

Important With Circle IconCreated with Sketch.Important

Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC .

Select your cloud service provider's tab for example cluster region names:

  • US_EAST_1
  • US_WEST_2
  • EU_WEST_1

For a complete list of supported AWS regions, see Amazon Web Services (AWS).

providerSettings.volumeTypestringConditional

Disk IOPS setting for AWS storage. Set only if you selected AWS as your cloud service provider.

Possible values are:

Volume TypeproviderSettings.diskIOPS Value
STANDARDMust not exceed the default IOPS rate for the selected volume size.
PROVISIONEDMust fall within the allowable IOPS range for the selected volume size.
replicationFactornumberOptional

Deprecated.

replicationFactor is deprecated. Use replicationSpecs.

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. Atlas accepts 3, 5, or 7. The default value is 3.

Don't specify this parameter when creating a multi-region cluster using the replicationSpec object.

If your cluster is a sharded cluster, each shard is a replica set with the specified replication factor.

Atlas ignores this value if you pass the replicationSpec object.

Bulb IconTip
replicationSpecobjectOptional

Deprecated.

replicationSpec is deprecated. Use replicationSpecs.

Configuration of each region in a multi-region cluster. Each element in this object represents a region where Atlas deploys your cluster.

For single-region clusters, you can either specify the providerSettings.regionName and replicationFactor, or you can use the replicationSpec object to define a single region.

For multi-region clusters, omit the providerSettings.regionName parameter.

For Global Clusters, specify the replicationSpecs parameter rather than a replicationSpec parameter.

Important With Circle IconCreated with Sketch.Important

If you use replicationSpec, you must specify a minimum of one replicationSpec.<region> object.

Use the replicationSpecs parameter to create a Global Cluster.

Info With Circle IconCreated with Sketch.Note

You cannot specify both the replicationSpec and replicationSpecs parameters in the same request body.

replicationSpec.<region>objectConditional
Important With Circle IconCreated with Sketch.Important
Use replicationSpecs[n].<region>

replicationSpec.<region> is deprecated. Use replicationSpecs[n].<region>.

Physical location of the region. Replace <region> with the name of the region. Each <region> object describes the region's priority in elections and the number and type of MongoDB nodes Atlas deploys to the region.

Important With Circle IconCreated with Sketch.Important

If you use replicationSpec, you must specify a minimum of one replicationSpec.<region> object.

Select your cloud service provider's tab for example cluster region names:

  • US_EAST_1
  • US_WEST_2
  • EU_WEST_1

For a complete list of supported AWS regions, see Amazon Web Services (AWS).

For each <region> object, you must specify the analyticsNodes, electableNodes, priority, and readOnlyNodes parameters.

Bulb IconTip
See Also:

During deployment of an M10+ dedicated paid cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.

For clusters deployed on AWS , if you want to create a VPC peering connection to an AWS VPC and require a specific CIDR block for a given region, you must create a VPC connection before deploying the cluster. See Set up a Network Peering Connection for for complete documentation on VPC peering connections.

Important With Circle IconCreated with Sketch.Important

Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC .

replicationSpec.<region>.analyticsNodesnumberOptional
Important With Circle IconCreated with Sketch.Important
Use replicationSpecs[n].<region>.analyticsNodes

replicationSpec.<region>.analyticsNodes is deprecated. Use replicationSpecs[n].<region>.analyticsNodes.

The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

If you do not specify this option, no analytics nodes are deployed to the region.

replicationSpec.<region>.electableNodesnumberOptional
Important With Circle IconCreated with Sketch.Important
Use replicationSpecs[n].<region>.electableNodes

replicationSpec.<region>.electableNodes is deprecated. Use replicationSpecs[n].<region>.electableNodes.

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.

The total number of electableNodes across all replicationSpec.<region> object must be 3, 5, or 7.

Specify 0 if you do not want any electable nodes in the region.

You cannot create electable nodes if the replicationSpec.<region>.priority is 0.

replicationSpec.<region>.prioritynumberOptional
Important With Circle IconCreated with Sketch.Important
Use replicationSpecs[n].<region>.priority

replicationSpec.<region>.priority is deprecated. Use replicationSpecs[n].<region>.priority.

Election priority of the region. For regions with only replicationSpec.<region>.readOnlyNodes, set this value to 0.

For regions where replicationSpec.<region>.electableNodes is at least 1, each replicationSpec.<region> must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1.

The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive: you can't assign a given priority to more than one region per cluster.

Beaker IconExample

If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

replicationSpec.<region>.readOnlyNodesnumberOptional
Important With Circle IconCreated with Sketch.Important
Use replicationSpecs[n].<region>.readOnlyNodes

replicationSpec.<region>.readOnlyNodes is deprecated. Use replicationSpecs[n].<region>.readOnlyNodes.

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

Specify 0 if you do not want any read-only nodes in the region.

replicationSpecsarray of objectsConditional

Configuration for cluster regions.

Info With Circle IconCreated with Sketch.Note
When should you use replicationSpecs?
ConditionNecessityValues
You are deploying Global Clusters.RequiredEach object in the array represents a zone where Atlas deploys your cluster's nodes.
You are deploying non-Global replica sets and sharded clusters.OptionalThis array has one object representing where Atlas deploys your cluster's nodes.

You must specify all parameters in replicationSpecs object array.

Info With Circle IconCreated with Sketch.Note
What parameters depend on replicationSpecs?

If you set replicationSpecs, you must:

  • Set clusterType
  • Set numShards
  • Not set replicationSpec
  • Not use clusters with local NVMe SSDs
  • Not use Azure clusters
replicationSpecs[n].numShardsnumberRequiredNumber of shards to deploy in each specified zone. The default value is 1.
replicationSpecs[n].regionsConfigobjectOptional

Configuration for a region. Each regionsConfig object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.

Important With Circle IconCreated with Sketch.Important

If you use replicationSpecs, you must specify a minimum of one replicationSpecs[n].regionsConfig.<region> string.

replicationSpecs[n].regionsConfig.<region>objectRequired

Physical location of the region. Replace <region> with the name of the region. Each <region> object describes the region's priority in elections and the number and type of MongoDB nodes Atlas deploys to the region.

Select your cloud service provider's tab for example cluster region names:

  • US_EAST_1
  • US_WEST_2
  • EU_WEST_1

For a complete list of supported AWS regions, see Amazon Web Services (AWS).

For each <region> object, you must specify the analyticsNodes, electableNodes, priority, and readOnlyNodes parameters.

Bulb IconTip
See Also:

During deployment of an M10+ dedicated paid cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.

For clusters deployed on AWS , if you want to create a VPC peering connection to an AWS VPC and require a specific CIDR block for a given region, you must create a VPC connection before deploying the cluster. See Set up a Network Peering Connection for for complete documentation on VPC peering connections.

Important With Circle IconCreated with Sketch.Important

Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC .

replicationSpecs[n].regionsConfig.<region>.analyticsNodesnumberOptionalThe number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.If you do not specify this option, no analytics nodes are deployed to the region.
replicationSpecs[n].regionsConfig.<region>.electableNodesnumberOptional

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.

The total number of electableNodes across all replicationSpecs[n].regionsConfig.<region> object must be 3, 5, or 7.

Specify 0 if you do not want any electable nodes in the region.

You cannot create electable nodes if the replicationSpecs[n].regionsConfig.<region>.priority is 0.

replicationSpecs[n].regionsConfig.<region>.prioritynumberOptional

Election priority of the region. For regions with only replicationSpecs[n].regionsConfig.<region>.readOnlyNodes, set this value to 0.

For regions where replicationSpecs[n].regionsConfig.<region>.electableNodes is at least 1, each replicationSpecs[n].regionsConfig.<region> must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1.

The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive: you can't assign a given priority to more than one region per cluster.

Beaker IconExample

If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

replicationSpecs[n].regionsConfig.<region>.readOnlyNodesnumberOptional

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

Specify 0 if you do not want any read-only nodes in the region.

replicationSpecs[n].zoneNamestringOptionalName for the zone in a Global Cluster. Don't provide this value if clusterType is not GEOSHARDED.
NameTypeDescription
autoScalingobject

Collection of settings that configures auto-scaling information for the cluster.

Bulb IconTip
autoScaling.autoIndexingEnabledboolean

Flag that indicates whether autopilot mode for Performance Advisor is enabled. The default is false.

Important With Circle IconCreated with Sketch.Important

Autopilot mode is only available if you are enrolled in the Auto Pilot Early Access program.

autoScaling.computeobjectCollection of settings that configure how a cluster might scale its cluster tier and whether the cluster can scale down.
autoScaling.compute.enabledbooleanFlag that indicates whether cluster tier auto-scaling is enabled.
autoScaling.compute.scaleDownEnabledbooleanFlag that indicates whether the cluster tier can scale down.
autoScaling.diskGBEnabledbooleanFlag that indicates whether disk auto-scaling is enabled.
backupEnabledboolean

Flag that indicates whether legacy backup has been enabled.

Important With Circle IconCreated with Sketch.Important

Clusters running MongoDB FCV 4.2 or later and any newnew Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backups: providerBackupEnabled

This change doesn't affect existing Atlas clusters that use legacy backups.

biConnectorobject

Collection of settings that configure a BI Connector for Atlas for the 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.

biConnector.enabledbooleanFlag that indicates whether Atlas enabled the BI Connector for Atlas for this cluster.
biConnector.readPreferencestring

Source from which the BI Connector for Atlas reads data.

ValueDescription
primaryBI Connector for Atlas reads data from the primary.
secondaryBI Connector for Atlas reads data from a secondary.
analytics
BI Connector for Atlas reads data from an
analytics node.
clusterTypestring

Type of the cluster:

ValueDescription
REPLICASETreplica set
SHARDEDsharded cluster
GEOSHARDEDglobal cluster
connectionStringsobject

Set of connection strings that your applications use to connect to this cluster.

Use the parameters in this object to connect your applications to this cluster.

Bulb IconTip

Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

connectionStrings.privateEndpointarray of objectsPrivate endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connectionStrings.privateEndpoint[n].connectionStringstringPrivate-endpoint-aware mongodb://connection string for this private endpoint.
connectionStrings.privateEndpoint[n].endpointsarray of objectsPrivate endpoint through which you connect to Atlas when you use connectionStrings.privateEndpoint[n].connectionString or connectionStrings.privateEndpoint[n].srvConnectionString.
connectionStrings.privateEndpoint[n].endpoints[n].endpointIdstringUnique identifier of the private endpoint.
connectionStrings.privateEndpoint[n].endpoints[n].providerNamestringCloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connectionStrings.privateEndpoint[n].endpoints[n].regionstringRegion to which you deployed the private endpoint.
connectionStrings.privateEndpoint[n].srvConnectionStringstring

Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.

The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:

  • Append the seed list or
  • Change the URI if the nodes change.

Use this URI format if your driver supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.

Bulb IconTip
See Also:
connectionStrings.privateEndpoint[n].typestring

Type of MongoDB process that you connect to with the connection strings. Atlas returns:

  • MONGOD for replica sets, or
  • MONGOS for sharded clusters.
connectionStrings.standardstringPublic mongodb:// connection string for this cluster.
connectionStrings.standardSrvstring

Public mongodb+srv:// connection string for this cluster.

Bulb IconTip
See Also:
connectionStrings.privatestring

Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Atlas returns this parameter only if you created a network peering connection to this cluster.

Info With Circle IconCreated with Sketch.Note

For AWS clusters, Atlas doesn't return this parameter unless you enable custom DNS.

connectionStrings.privateSrvstring

Network-peering-endpoint-aware mongodb+srv:// connection strings for each interface VPC endpoint you configured to connect to this cluster. Atlas returns this parameter only if you created a network peering connection to this cluster.

The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:

  • Append the seed list or
  • Change the URI if the nodes change.

Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private.

Bulb IconTip
See Also:
Info With Circle IconCreated with Sketch.Note

For AWS clusters, Atlas doesn't return this parameter unless you enable custom DNS.

connectionStrings.awsPrivateLinkobject
Important With Circle IconCreated with Sketch.Important

This field is deprecated. Use connectionStrings.privateEndpoint[n].connectionString instead.

Info With Circle IconCreated with Sketch.Note

Atlas returns this parameter only if:

  • the cluster is deployed to AWS , and
  • you deployed a AWS PrivateLink private endpoint to the same regions as all of this cluster's nodes.

Private-endpoint-aware mongodb://connection strings for each AWS PrivateLink private endpoint. Atlas returns this parameter only if you deployed a AWS PrivateLink private endpoint to the same regions as all of this cluster's nodes.

In this object:

  • Each key is the unique identifier of an interface endpoint.
  • Each value is the mongodb:// connection string you use to connect to Atlas through the interface endpoint the key names.
connectionStrings.awsPrivateLinkSrvobject
Important With Circle IconCreated with Sketch.Important

This field is deprecated. Use connectionStrings.privateEndpoint[n].srvConnectionString instead.

Info With Circle IconCreated with Sketch.Note

Atlas returns this parameter only if:

  • the cluster is deployed to AWS , and
  • you deployed a AWS PrivateLink private endpoint to the same regions as all of this cluster's nodes.

Private-endpoint-aware mongodb+srv:// connection strings for each AWS PrivateLink private endpoint.

In this object:

  • Each key is the unique identifier of an interface endpoint.
  • Each value is the mongodb+srv:// connection string you use to connect to Atlas through the interface endpoint the key names.

The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:

  • Append the seed list or
  • Change the URI if the nodes change.

Use this URI format if your driver supports it. If it doesn't, use connectionStrings.awsPrivateLink.

Bulb IconTip
See Also:
createDatestringTimestamp in ISO 8601 date and time format in UTC when Atlas created the cluster.
diskSizeGBnumber

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive integer.

Info With Circle IconCreated with Sketch.Note
When should you use diskSizeGB?

This setting:

The minimum disk size for dedicated clusters is 10 GB for AWS and GCP , and 32 GB for Azure . If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.

Important With Circle IconCreated with Sketch.Important

Atlas calculates storage charges differently depending on whether you choose the default value or a custom value.

Bulb IconTip
See Also:
Info With Circle IconCreated with Sketch.Note

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.

encryptionAtRestProviderstring

Cloud service provider that offers Encryption at Rest.

groupIdstringUnique identifier of the project to which the cluster belongs.
idstringUnique identifier of the cluster.
labelsarray of documentsCollection of key-value pairs that tag and categorize the cluster.
mongoDBVersionstringVersion of MongoDB the cluster runs, in <major version>.<minor version> format.
mongoDBMajorVersionstring

Major version of MongoDB the cluster runs:

  • 3.6
  • 4.0
  • 4.2
  • 4.4
mongoURIstring

Base connection string for the cluster.

Atlas only displays this parameter after the cluster is operational, not while it builds the cluster.

mongoURIUpdatedstringTimestamp in ISO 8601 date and time format in UTC when the connection string was last updated. The connection string changes if you update any of the other values.
mongoURIWithOptionsstring

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

To review the connection string format, see the connection string format documentation. To add database users to a Atlas project, see Configure Database Users.

Atlas only displays this parameter after the cluster is operational, not while it builds the cluster.

namestringName of the cluster as it appears in Atlas.
numShardsnumber

Positive integer that specifies the number of shards for a sharded cluster.

If this is set to 1, the cluster is a replica set.

If this is set to 2 or higher, the cluster is a sharded cluster with the number of shards specified.

Bulb IconTip
See Also:

Atlas might return values between 1 and 50.

Info With Circle IconCreated with Sketch.Note

Atlas doesn't return this value in the response body for Global Clusters.

pausedbooleanFlag that indicates whether the cluster is paused.
pitEnabledbooleanFlag that indicates if the cluster uses Continuous Cloud Backup backups.
providerBackupEnabledboolean

Applicable only for M10+ clusters.

Flag that indicates if the cluster uses Cloud Backups for backups.

If true, the cluster uses Cloud Backups for backups. If providerBackupEnabled and backupEnabled are false, the cluster does not use Atlas backups.

providerSettingsobjectConfiguration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider.
providerSettings.autoScalingobject

Range of instance sizes to which your cluster can scale.

Important With Circle IconCreated with Sketch.Important

You can't specify the providerSettings.autoScaling object if "autoScaling.compute.enabled" : false.

providerSettings.autoScaling.computeobjectRange of instance sizes to which your cluster can scale. Atlas requires this parameter if "autoScaling.compute.enabled" : true.
providerSettings.autoScaling.compute.minInstanceSizestringMinimum instance size to which your cluster can automatically scale.
providerSettings.autoScaling.compute.maxInstanceSizestringMaximum instance size to which your cluster can automatically scale.
providerSettings.backingProviderNamestring

Cloud service provider on which the multi-tenant host is provisioned. Atlas returns this parameter only if "providerSettings.providerName" : "TENANT".

Atlas can return:

AWSAmazon AWS
GCPGoogle Cloud Platform
AZUREMicrosoft Azure
providerSettings.providerNamestring

Cloud service provider on which Atlas provisioned the hosts.

Atlas can return:

AWSAmazon AWS
GCPGoogle Cloud Platform
AZUREMicrosoft Azure
TENANT

M2 or M5 multi-tenant cluster.

See providerSettings.backingProviderName for the cloud service provider where Atlas provisioned the host serving the cluster.

providerSettings.regionNamestring

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases.

For a complete list of region name values, refer to the the cloud provider reference pages:

For multi-region clusters, see replicationSpec.<region>.

providerSettings.diskIOPSnumberMaximum IOPS the system can perform.
providerSettings.diskTypeNamestring

Disk type of the host's root volume for Azure instances.

The following table lists the possible values for this parameter, and their corresponding storage size.

diskTypeNameStorage Size
P4 [1]32GB
P664GB
P10 [2]128GB
P15256GB
P20512GB
P301024GB
P402048GB
P504095GB
[1] Default for M20 and M30 Azure cluster tiers
[2] Default for M40+ Azure cluster tiers
providerSettings.encryptEBSVolumebooleanFlag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster.
providerSettings.instanceSizeNamestring

Name of the cluster tier used for the Atlas cluster.

Atlas supports the following cluster tiers. Atlas supports deploying M2 and M5 tiers into a subset of available regions. The documentation for providersettings.regionName includes a list of these regions.

Info With Circle IconCreated with Sketch.Note
Cluster Tier Naming Conventions

Cluster tier names that are:

  • Appended with _NVME (M40_NVME for example) use direct attached NVMe storage for exceptional performance with the most I/O-intensive workloads.
  • Prepended with R instead of an M (R40 for example) run a low CPU version of the cluster.
Instance SizeDefault StorageDefault RAM
M22 GBShared
M55 GBShared
M1010 GB2 GB
M2020 GB4 GB
M3040 GB8 GB
M4080 GB16 GB
M40 Low-CPU (R40)80 GB16 GB
M40_NVME380 GB15.25 GB
M50160 GB32 GB
M50 Low-CPU (R50)160 GB32 GB
M50_NVME760 GB30.5 GB
M60320 GB64 GB
M60 Low-CPU (R60)320 GB64 GB
M60_NVME1.6 TB61 GB
M80760 GB131 GB
M80 Low-CPU (R80)750 GB122 GB
M80_NVME1.6 TB122 GB
M1001 TB160 GB
M140 11 TB192 GB
M2001.5 TB256 GB
M200 Low-CPU (R200)1.5 TB256 GB
M200_NVME3.1 TB244 GB
M300 12 TB384 GB
M300 Low-CPU (R300)2 TB384 GB
M400 Low-CPU (R400)3 TB488 GB
M400_NVME 24 TB512 GB
M700 Low-CPU (R700)4 TB768 GB

1 Unavailable in the AP_SOUTHEAST_2 region.

2 Availability limited to the following regions:

  • US_EAST_1
  • US_EAST_2
  • US_WEST_2
  • EU_WEST_1
  • EU_CENTRAL_1
  • AP_NORTHEAST_1
Important With Circle IconCreated with Sketch.Important

M2 and M5 clusters are multi-tenant deployments. You must set providerSettings.providerName to TENANT and specify the cloud service provider in providerSettings.backingProviderName.

replicationFactornumber

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy.

For multi-region clusters, add the total number of replicationSpec.<region>.electableNodes to calculate the replication factor of the cluster.

If your cluster is a sharded cluster, each shard is a replica set with the specified replication factor.

Atlas may return 3, 5, or 7.

Bulb IconTip
replicationSpecobjectConfiguration of each region in the cluster. Each element in this object represents a region where Atlas deploys your cluster.
replicationSpec.<region>object

Physical location of the region. The <region> string corresponds to a region where Atlas deploys your cluster.

Each <region> object describes the region's priority in elections and the number and type of MongoDB nodes Atlas deploys to the region.

replicationSpec.<region>.analyticsNodesnumberNumber of analytics nodes in the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.
replicationSpec.<region>.electableNodesnumberNumber of electable nodes in the region. Electable nodes can become the primary and can facilitate local reads.
replicationSpec.<region>.prioritynumber

Election priority of the region. The highest possible priority is 7, which identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. The lowest possible priority is 0, which identifies a read-only region.

You can have any number of priority 0 read only regions. Priorities 1 through 7 are exclusive: only one region per cluster can be assigned a given priority.

replicationSpec.<region>.readOnlyNodesnumberNumber of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads.
replicationSpecsarrayConfiguration for each zone in a Global Cluster. Each object in this array represents a zone where Atlas deploys nodes for your Global Cluster.
replicationSpecs[n].idstringUnique identifier of the replication object.
replicationSpecs[n].zoneNamestringName for the zone.
replicationSpecs[n].numShardsnumberNumber of shards to deploy in the specified zone.
replicationSpecs[n].regionsConfigobjectPhysical location of the region. Each regionsConfig object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.
replicationSpecs[n].regionsConfig.<region>.analyticsNodesnumberThe number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.If you do not specify this option, no analytics nodes are deployed to the region.
replicationSpecs[n].regionsConfig.<region>.electableNodesnumberNumber of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
replicationSpecs[n].regionsConfig.<region>.readOnlyNodesnumber

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

Specify 0 if you do not want any read-only nodes in the region.

replicationSpecs[n].regionsConfig.<region>.prioritynumberElection priority of the region. If you have regions with only read-only nodes, set this value to 0.
replicationSpecs[n].zoneNamestringName for the zone in a Global Cluster. Do not provide this value if clusterType is not GEOSHARDED.
srvAddressstringConnection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS . The mongoURI parameter lists additional options.
stateNamestring

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Content-Type: application/json" \
3 --include \
4 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters?pretty=true" \
5 --data '
6 {
7 "name": "SingleRegionCluster",
8 "diskSizeGB": 100,
9 "numShards": 1,
10 "providerSettings": {
11 "providerName": "AWS",
12 "diskIOPS": 300,
13 "instanceSizeName": "M40",
14 "regionName": "US_EAST_1"
15 },
16 "clusterType" : "REPLICASET",
17 "replicationFactor": 3,
18 "replicationSpecs": [{
19 "numShards": 1,
20 "regionsConfig": {
21 "US_EAST_1": {
22 "analyticsNodes": 0,
23 "electableNodes": 3,
24 "priority": 7,
25 "readOnlyNodes": 0
26 }
27 },
28 "zoneName": "Zone 1"
29 }],
30 "backupEnabled": false,
31 "providerBackupEnabled" : true,
32 "autoScaling": {
33 "diskGBEnabled": true
34 }
35 }'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "autoScaling":{
3 "compute":{
4 "enabled":false,
5 "scaleDownEnabled":false
6 },
7 "diskGBEnabled":true
8 },
9 "backupEnabled":false,
10 "biConnector":{
11 "enabled":false,
12 "readPreference":"secondary"
13 },
14 "clusterType":"REPLICASET",
15 "connectionStrings":{
16 "privateEndpoint":[
17 {
18 "connectionString":"mongodb://pl-0-us-east-1.uzgh6.mongodb.net:1024,pl-0-us-east-1.uzgh6.mongodb.net:1025,pl-0-us-east-1.uzgh6.mongodb.net:1026/?ssl=true&authSource=admin&replicaSet=atlas-8dhkjj-shard-0",
19 "endpoints":[
20 {
21 "endpointId":"vpce-0c86b555d9a233152",
22 "providerName":"AWS",
23 "region":"US_EAST_1"
24 }
25 ],
26 "srvConnectionString":"mongodb+srv://cluster1-pl-0.uzgh6.mongodb.net",
27 "type":"MONGOD"
28 }
29 ],
30 "standardSrv":"mongodb+srv://cluster1.uzgh6.mongodb.net",
31 "awsPrivateLink":{
32 "vpce-0c86b555d9a233152":"mongodb://pl-0-us-east-1.uzgh6.mongodb.net:1024,pl-0-us-east-1.uzgh6.mongodb.net:1025,pl-0-us-east-1.uzgh6.mongodb.net:1026/?ssl=true&authSource=admin&replicaSet=atlas-8dhkjj-shard-0"
33 },
34 "awsPrivateLinkSrv":{
35 "vpce-0c86b555d9a233152":"mongodb+srv://cluster1-pl-0.uzgh6.mongodb.net"
36 },
37 "standard":"mongodb://cluster1-shard-00-00.uzgh6.mongodb.net:27017,cluster1-shard-00-01.uzgh6.mongodb.net:27017,cluster1-shard-00-02.uzgh6.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-8dhkjj-shard-0"
38 },
39 "diskSizeGB":100.0,
40 "encryptionAtRestProvider":"NONE",
41 "groupId":"{GROUP-ID}",
42 "id":"{CLUSTER-ID}",
43 "labels":[
44
45 ],
46 "mongoDBMajorVersion":"4.0",
47 "mongoDBVersion":"4.0.13",
48 "mongoURIUpdated":"2019-12-11T17:34:08Z",
49 "name":"SingleRegionCluster",
50 "numShards":1,
51 "paused":false,
52 "pitEnabled":false,
53 "providerBackupEnabled":true,
54 "providerSettings":{
55 "providerName":"AWS",
56 "autoScaling":{
57 "compute":{
58 "maxInstanceSize":null,
59 "minInstanceSize":null
60 }
61 },
62 "diskIOPS":300,
63 "encryptEBSVolume":true,
64 "instanceSizeName":"M40",
65 "regionName":"US_EAST_1",
66 "volumeType":"STANDARD"
67 },
68 "replicationFactor":3,
69 "replicationSpec":{
70 "US_EAST_1":{
71 "analyticsNodes":0,
72 "electableNodes":3,
73 "priority":7,
74 "readOnlyNodes":0
75 }
76 },
77 "replicationSpecs":[
78 {
79 "id":"{REPLICA-ID}",
80 "numShards":1,
81 "regionsConfig":{
82 "US_EAST_1":{
83 "analyticsNodes":0,
84 "electableNodes":3,
85 "priority":7,
86 "readOnlyNodes":0
87 }
88 },
89 "zoneName":"Zone 1"
90 }
91 ],
92 "stateName":"IDLE",
93 "links":[]
94}
Give Feedback