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.

For complete documentation on Encryption-at-Rest restrictions,
see Restrictions.

You must configure encryption at rest for the Atlas project
before enabling it on any cluster in the project. For
complete documentation on configuring Encryption at Rest,
see Encryption at Rest via AWS KMS.

groupId

string

Unique identifier of the project the cluster belongs to.

id

string

Unique identifier of the cluster.

mongoDBVersion

string

Version of MongoDB the cluster runs, in
<majorversion>.<minorversion> format.

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

1 Not available if providerSettings.regionName
is SOUTH_AMERICA_EAST_1 , EUROPE_WEST_3,
NORTHEASTERN_ASEA_PACIFIC, or AUSTRALIA_SOUTHEAST_1

Instance Size

Default Storage

Default RAM

M2

2GB

Shared

M5

5GB

Shared

M10

32GB

2GB

M20

32GB

4GB

M30

32GB

8GB

M40

128GB

16GB

M50

128GB

32GB

M60

128GB

64GB

M80

256GB

128GB

M200

256GB

256GB

Important

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

providerSettings

.diskIOPS

integer

Maximum input/output operations per second (IOPS) the
system can perform.

providerSettings

.diskTypeName

string

Azure Only The disk type of the server’s root volume.

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

diskTypeName

Storage Size

P41

32GB

P6

64GB

P102

128GB

P20

512GB

P30

1024GB

P40

2048GB

P50

4095GB

1 Default for M20 and M30 Azure instances

2 Default for M40+ Azure instances

providerSettings

.encryptEBSVolume

boolean

AWS only. If enabled, the Amazon EBS encryption feature
encrypts the server’s root volume for both data at rest within
the volume and for data moving between the volume and the
instance.

replicationFactor

number

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.

For information on how the replication factor affects costs, see
Number of Servers. For more information on MongoDB
replica sets, see Replication in the
MongoDB manual.

The possible values are 3, 5, or 7.

replicationSpec

document

Configuration of each region in the cluster. Each element
in this document represents a region where Atlas deploys
your cluster.

replicationSpec

.<region>

document

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

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

replicationSpec

.<region>

.electableNodes

integer

Number of electable nodes in the region. Electable nodes
can become the primary and can facilitate local reads.

replicationSpec

.<region>

.priority

integer

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 - no more than one
region per cluster can be assigned a given priority.

replicationSpec

.<region>

.readOnlyNodes

integer

Number of read-only nodes in the region. Read-only nodes
can never become the primary, but can facilitate
local-reads.

replicationSpec.<region>.analyticsNodes

integer

The number 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.

replicationSpecs

array of documents

Configuration for each zone in a
Global Cluster. Each document in this
array represents a zone where Atlas deploys nodes for your
Global Cluster.

replicationSpecs[n]

.id

string

Unique identifier of the replication document.

replicationSpecs[n]

.zoneName

string

Name for the zone.

replicationSpecs[n]

.numShards

integer

Number of shards to deploy in the specified zone.

replicationSpecs[n]

.regionsConfig

document

Physical location of the region. Each regionsConfig
document describes the region’s priority in elections and the
number and type of MongoDB nodes Atlas deploys to the region.

srvAddress

string

Connection string
for connecting to the Atlas cluster. The +srv modifier
forces the connection to use TLS/SSL. See the mongoURI
for additional options.