Creates one cloud provider container with a VPC into which Atlas
can deploy clusters. An Atlas project can have a maximum of one
AWS container per AWS region and one GCP container.

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.

Atlas uses the specified CIDR block for all other VPC peering
connections created in the project.

The Atlas CIDR block must be at least a /24 and at
most a /21 in one of the following private networks.

The Atlas CIDR block must be at least a /18 in one
of the following private networks.

Lower Bound

Upper Bound

Prefix

10.0.0.0

10.255.255.255

10/8

172.16.0.0

172.31.255.255

172.16/12

192.168.0.0

192.168.255.255

192.168/16

Atlas locks this value if an M10+ cluster or a VPC peering
connection already exists. To modify the CIDR block, ensure there are
no M10+ clusters in the project and no other VPC peering
connections in the project.

Alternatively, create a new project
and create a VPC Peering Connection to set the desired Atlas
VPCCIDR block for that project.

Important

Atlas limits the number of MongoDB nodes per VPC based on the
CIDR block and the region selected for the project.

Example

A project in an AWS region supporting 3 availability
zones and a Atlas CIDRVPC block of /24 is
limited to the equivalent of 27 three-node replica sets.

A project with an Atlas VPCCIDR block of
/18 is limited to approximately 80 three-node
replica sets per GCP region.

Contact MongoDB Support for any questions on
Atlas limits of MongoDB nodes per VPC.

providerName

string

Optional

Cloud provider for this VPC peering connection.
If omitted, Atlas sets this parameter to AWS.

regionName

string

Required

AWS Region.

Parameter

Type

Necessity

Description

atlasCidrBlock

string

Required

CIDR block that Atlas uses for your clusters.

Atlas uses the specified CIDR block for all other VPC peering
connections created in the project.

The Atlas CIDR block must be at least a /24 and at
most a /21 in one of the following private networks.

The Atlas CIDR block must be at least a /18 in one
of the following private networks.

Lower Bound

Upper Bound

Prefix

10.0.0.0

10.255.255.255

10/8

172.16.0.0

172.31.255.255

172.16/12

192.168.0.0

192.168.255.255

192.168/16

Atlas locks this value if an M10+ cluster or a VPC peering
connection already exists. To modify the CIDR block, ensure there are
no M10+ clusters in the project and no other VPC peering
connections in the project.

Alternatively, create a new project
and create a VPC Peering Connection to set the desired Atlas
VPCCIDR block for that project.

Important

Atlas limits the number of MongoDB nodes per VPC based on the
CIDR block and the region selected for the project.

Example

A project in an AWS region supporting 3 availability
zones and a Atlas CIDRVPC block of /24 is
limited to the equivalent of 27 three-node replica sets.

A project with an Atlas VPCCIDR block of
/18 is limited to approximately 80 three-node
replica sets per GCP region.

Contact MongoDB Support for any questions on
Atlas limits of MongoDB nodes per VPC.

providerName

string

Required

Cloud provider for this VPC peering connection.
Set this value to GCP.