FAQ >
Connection String Options

Connection String Options¶

On this page

Why does my cluster have multiple connection strings?
What does this mean for GCP or Azure clusters in peering-only mode?
Can my VNet-peered Azure cluster span multiple regions?
How do I disable peering-only mode?
How does this affect AWS VPC peering when I use custom DNS?
Can Atlas be used with AWS Transit Gateway?
Can Atlas be used with AWS Direct Connect?
How do I identify which connection string my application uses?

Atlas provides multiple connection strings. These strings allow you to connect to your clusters from both public and private contexts.

Why does my cluster have multiple connection strings?¶

To connect to Atlas, point your applications to a URI to communicate with a cluster. Atlas creates clusters with more than one node or host. Each node has its own hostname that resolves to an IP address. The URI, known as a connection string, to which Atlas connects might have more than one hostname. Configure Atlas to accept connections to the cluster hosts from whitelisted IP addresses.

Atlas secures connections from public IP address through authentication and TLS. If you want to connect to private IP addresses, you can use:

These features all manage communication over internal IP addresses within secure networks.

Atlas provides more than one connection string when using secure networks. Each network offers a string that resolves to different IP addresses.

All clusters have a standard connection string. This resolves to the cluster’s:

Public IP addresses for Internet connections and
VPC private IP addresses for AWS clusters when resolved from a peered VPC.

Use this string for applications connecting over the Internet or connecting to peered clusters in AWS.

Clusters with peered networks have a Private IP for Peering connection string. This string resolves to IP addresses available to:

Peered networks in Azure or GCP
AWS peered clusters with a custom DNS service.

Use this connection string with applications connecting:

Within an Azure or GCP peered network
To AWS clusters when using AWS with custom DNS service.

AWS clusters with AWS PrivateLink configured have one or more connection strings. Each string resolves to the IP address of an Endpoint Interface. Use these connection strings with applications connecting over PrivateLink.

What does this mean for GCP or Azure clusters in peering-only mode?¶

Before 31 March 2020, you were required to enable peering-only mode to connect to databases on peer networked Azure or GCP clusters. This mode:

Affected global DNS resolution and
Limited any database connections outside the peered network.

Multiple horizons lifts these restrictions and unlocks additional features. In projects running MongoDB 3.6 or later clusters, you can use:

To leverage multiple horizons:

Make sure your clusters use MongoDB 3.6 or later,
Update your application’s existing connection strings to use Private IP for Peering connection strings,
Disable Peering-Only mode, and
Connect using the strings outlined in Why does my cluster have multiple connection strings?.

Note

You can keep connecting to your clusters using existing peering-enabled connection strings at this time. Peering-Only mode prevents access to the improved functionality and reduced limitations of multiple horizons. To use the new features and remove the legacy limitations, MongoDB requires that you use the new connection strings.

Can my VNet-peered Azure cluster span multiple regions?¶

Yes.

Change your applications to connect using the Private IP for Peering connection string. This change allows your applications to connect from peered networks using the UI or API.

To expand into more regions, disable Peering-Only mode on existing Azure clusters first.

Private IP for Peering connection strings work with MongoDB 3.6 or later clusters.

How do I disable peering-only mode?¶

To disable Peering-Only mode using the:

Atlas Console
Atlas API

1

Verify all clusters in your project use MongoDB 3.6 or later.¶

If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Clusters page is not already displayed, click Clusters in the sidebar.
Check the Version number under the cluster name in each cluster card on the Clusters page.

For each cluster that doesn’t run MongoDB 3.6 or later, upgrade the MongoDB version of that cluster.

2

Update All Applications to Use Private IP for Peering Connection Strings.¶

Change any URLs in your applications that use your Atlas clusters to use Private IP for Peering connection strings.

3

Navigate to the Settings page for your project.¶

Next to the Projects menu, expand the Options menu.
Click Project Settings.

4

Disable Connect via Peering Only.¶

Toggle Connect via Peering Only (GCP and Azure) to Off.

1

Verify all clusters in your project use MongoDB 3.6 or later.¶

Call the Get All Clusters API endpoint to return all clusters and their MongoDB versions:

Example

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/clusters?pretty=true"

If successful, the response should include:

copy

{
  "results": [{
    ...
    "mongoDBMajorVersion": "4.2",
    "mongoDBVersion": "4.2.3",
    ...
  },{
    ...
    "mongoDBMajorVersion": "4.0",
    "mongoDBVersion": "4.0.14",
    ...       }
  ]
}

If all clusters return a "mongoDBMajorVersion" value of 3.6 or greater, you can continue. If need to upgrade, follow the Upgrade Major MongoDB Version for a Cluster procedure or call the Modify a Cluster endpoint to upgrade.

2

Update All Applications to Use Private IP for Peering Connection Strings.¶

Change any URLs in your applications that use your Atlas clusters to use Private IP for Peering connection strings.

3

Disable Private IP Mode on Your Clusters.¶

Call the API endpoint to Disable Private IP Mode.

Example

Using curl, you would invoke this command:

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/privateIpMode?pretty=true" \
     --data '
       {
         "enabled" : false
       }'

Change {PROJECT-ID} to the Project ID of your project.

If successful, the response displays:

copy

{
  "enabled" : false
}

How does this affect AWS VPC peering when I use custom DNS?¶

Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with Atlas couldn’t connect over private IP addresses:

Custom DNS resolved to public IP addresses.
AWS internal DNS resolved to private IP addresses.

Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings. To show these strings:

Toggle the Using Custom DNS on AWS with VPC Peering on On from the Project Settings menu.
View the connect modal for your AWS Cluster.
Select the Private IP for Peering connection string.

Can Atlas be used with AWS Transit Gateway?¶

Yes. AWS PrivateLink powers Atlas Private Endpoints. This allows for transitive connectivity. You can use the AWS Transit Gateway with your VPC if you connected your VPC to Atlas via AWS PrivateLink.

Can Atlas be used with AWS Direct Connect?¶

Yes. AWS PrivateLink powers Atlas Private Endpoints. This allows for transitive connectivity. You can use AWS Direct Connect with your VPC if you connected your VPC to Atlas via AWS PrivateLink.

How do I identify which connection string my application uses?¶

The structure of the connection string’s URI indicates the string’s type. If you have created a peering connection or private endpoint, Atlas displays more than one of these options for your use.

Standard Connection Strings¶

Standard connection strings follow this format:

copy

mongodb://xyz456-shard-00-00.abc123.mongodb.net:27017
mongodb+srv://xyz456.abc123.mongodb.net

The dot before abc123 matters. URIs using this format resolve to public IP addresses except when connecting from inside AWS with VPC-peering configured.

Important

This format changes one character from the Legacy Connection Strings: a hyphen (-) after the cluster name becomes a period (.).

Example

This legacy connection string:

copy

mongodb+srv://xyx456-abc123.mongodb.net

is written as this standard connection string:

copy

mongodb+srv://xyx456.abc123.mongodb.net

For new clusters, replica sets and shards don’t derive their name from the name of the cluster. The new names use a six alphanumeric character ID.

Private Connection Strings¶

Private connection strings follow this format:

copy

mongodb://xyx456-shard-00-00-pri.abc123.mongodb.net:27017
mongodb+srv://xyx456-pri.abc123.mongodb.net

The -pri before abc123 matters. URIs using this format resolve to private IP addresses reachable within the peered network.

Important

In new clusters, replica sets and shards don’t derive their name from the name of the cluster. The new names use a six alphanumeric character ID.

AWS Privatelink Connection Strings¶

AWS PrivateLink connection strings follow this format:

copy

mongodb://pl-us-east-1a.abc123.mongodb.net:1234
mongodb+srv://pl-us-east-1a.abc123.mongodb.net

URIs using this format can be reachable via the AWS VPC where someone configured PrivateLink, though access can be transient from other VPCs peered in turn.

Legacy Connection Strings¶

Before 31 March 2020, you wrote Atlas connection strings as follows:

AWS	foo-shard-00-00-abc123.mongodb.net foo-abc123.mongodb.net
Azure	foo-shard-00-00-abc123.azure.mongodb.net foo-abc123.azure.mongodb.net
GCP	foo-shard-00-00-abc123.gcp.mongodb.net foo-abc123.gcp.mongodb.net

If you enabled Private Only mode, these hostnames resolve to peered network IP addresses. If you disabled that mode, hostnames resolve to public IP addresses.

If your application uses a legacy connection string in Peering Only mode, switch to Private IP for Peering connection strings.

← Billing Database →