Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Stream Processing

Manage Stream Processing Instances

On this page

  • Prerequisites
  • View stream processing instances
  • Create a stream processing instance
  • Delete a stream processing instance
  • Edit a stream processing instance
  • Download Audit Logs

An Atlas Stream Processing instance provides a context for all of your operations on streaming data. The procedures in this page walk you through creating and configuring your stream processing instances.

Prerequisites

To create and configure a stream processing instance, 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 Stream Processing Instance.

    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.

View stream processing instances

To view your stream processing instances:

To list all stream processing instances in the project you specify using the Atlas CLI, run the following command:

atlas streams instances list [options]

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

atlas streams instances describe <name> [options]

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

Tip

See: Related Links

1

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

  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 Atlas Administration API provides different endpoints for retrieving one or all stream processing instances.

Return One Stream Instance

List All Stream Instances

Create a stream processing instance

To create a new stream processing instance:

To create one stream processing instance in the project you specify using the Atlas CLI, run the following command:

atlas streams instances create <name> [options]

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

Tip

See: Related Links

1

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

  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.

2

Create your stream processing instance.

  1. Click Create instance in the upper right corner.

  2. Configure your new stream processing instance.

    • Select a stream processing instance tier.

    • Select a Cloud Provider.

    • Select a Region from the dropdown menu.

    • Enter a string for the Instance Name. Each stream processing instance name must be unique within a project.

  3. Click Create.

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

Create One Stream Instance

Delete a stream processing instance

To delete a stream processing instance:

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

atlas streams instances delete <name> [options]

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

Tip

See: Related Links

1

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

  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.

2

Delete the stream processing instance.

  1. Locate the overview panel of the stream processing instance you want to delete

  2. Click the ellipsis ... icon in the upper-right.

  3. Click Delete instance.

  4. When prompted, type the name of the stream processing instance in the text field.

  5. Click Delete.

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

Delete One Stream Instance

Edit a stream processing instance

To edit an stream processing instance:

To update one stream processing instance in the project you specify using the Atlas CLI, run the following command:

atlas streams instances update <name> [options]

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

Tip

See: Related Links

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

Update One Stream Instance

Download Audit Logs

To download your stream processing instance audit logs:

To download audit logs of one stream processing instance you specify using the Atlas CLI, run the following command:

atlas streams instances download <tenantName> [options]

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

Tip

See: Related Links

1

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

  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.

2

Click . From the dropdown menu, select Audit Logs.

3

In the modal window, select a Time Period from the dropdown menu. This value determines the logging interval used to delimit events in the downloadable log file.

4

Click Download Logs.

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

Download Audit Logs for One Atlas Stream Processing Instance

Back

Security

Next

Manage Connections

On this page