Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Stream Processing

Manage Connections

On this page

Each Stream Processing Instance stores every configured connection to a streaming data source or sink in its connection registry. The procedures on this page walk you through creating and configuring your Atlas Stream Processing connections.

Prerequisites

To create and configure connections, you must have the following:

  • An Atlas project

  • An Atlas user with the Project Owner or the Project Stream Processing Owner role to manage a connection registry

    Note

    The Project Owner role allows you to create database deployments, manage project access and project settings, manage IP Access List entries, and more.

    The Project Stream Processing Owner role enables Atlas Stream Processing actions such as viewing, creating, deleting, and editing stream processing instances, and viewing, adding, modifying, and deleting connections in the connection registry.

    See Project Roles to learn more about the differences between the two roles.

  • An Atlas cluster

Add a Connection to the Connection Registry

For information on creating each type of connection, consult the following pages:

Each type has distinct configuration requirements.

View Connections in the Connection Registry

To view a connection to your stream processing instance:

To list all connections from one stream processing instance you specify using the Atlas CLI, run the following command:

atlas streams connections list [options]

To return the details for one stream processing connection you specify using the Atlas CLI, run the following command:

atlas streams connections describe <streamConnectionName> [options]

To learn more about the syntax and parameters for the previous commands, see the Atlas CLI documentation for atlas streams connections list and atlas streams connections describe.

Tip

See: Related Links

1

In Atlas, go to the Stream Processing page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Services heading.

    The Stream Processing page displays.

2

Go to the Connection Registry page.

  1. Locate the overview panel of the stream processing instance containing the connection registry you want to view.

  2. Click Configure.

  3. Select the Connection Registry tab.

Atlas Stream Processing displays all of the connections available in your instance connection registry.

The Atlas Administration API provides different endpoints for retrieving one or all connections in a connection registry.

View One Connection in a Connection Registry

List All Connections in a Connection Registry

To list all available connections using mongosh, use the sp.listConnections() method. It returns a list of documents describing each connection in the stream processing instance's connection registry. It has the following syntax:

sp.listConnections()

Modify a Connection from the Connection Registry

To modify a connection from a connection registry:

To modify the details of one connection on the stream processing instance you specify using the Atlas CLI, run the following command:

atlas streams connections update <connectionName> [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas streams connections update.

Tip

See: Related Links

1

In Atlas, go to the Stream Processing page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Services heading.

    The Stream Processing page displays.

2

Go to the Connection Registry.

Locate the overview panel of the stream processing instance that contains the connection registry that you want to modify and click Configure in the upper right.

3

Select the Connection Registry tab.

4

Modify the connection.

  1. For the connection that you want to modify in the table, click the pencil icon in the Actions column.

    You can edit a connection only if it is not currently in use by a stream processor. If you want to edit a connection in use, stop all stream processors that use the connection first.

  2. Modify the fields you want to modify.

  3. Click Save changes.

The Atlas Administration API provides an endpoint for editing a stream processing instance.

Delete One Stream Instance

Delete a Connection from the Connection Registry

To delete a connection from a connection registry:

To remove one connection from the stream processing instance you specify using the Atlas CLI, run the following command:

atlas streams connections delete <connectionName> [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas streams connections delete.

Tip

See: Related Links

1

In Atlas, go to the Stream Processing page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Stream Processing under the Services heading.

    The Stream Processing page displays.

2

Go to the Connection Registry.

  1. Locate the overview panel of the stream processing instance that contains the connection registry that you want to modify

  2. Click Configure in the upper right.

  3. Select the Connection Registry tab.

3

Delete the connection.

  1. For the connection you want to modify in the table, click the trash can icon in the Actions column of that entry.

  2. When prompted, click Delete.

The Atlas Administration API provides an endpoint for editing a stream processing instance.

Delete One Stream Instance

List Private Link Connections

The Atlas Administration API provides an endpoint for viewing all Private Link connections configured for Atlas Stream Processing within a specified project.

Return All Private Links

View One Private Link Connection

The Atlas Administration API provides an endpoint for viewing the details of one Private Link connection configured for Atlas Stream Processing within a specified project.

Return One Private Link

Delete a Private Link Connection

The Atlas Administration API provides an endpoint for deleting a Private Link connection configured for Atlas Stream Processing within a specified project.

Delete One Private Link

Back

Manage Stream Processing Instances

Next

Kafka Connections