Docs Menu

Docs Home → Launch & Manage MongoDB → MongoDB Atlas

Tags on Database Deployments

On this page

  • Database Deployment Tagging Considerations
  • Manage cluster Tags from the Database Deployments Page
  • Manage cluster Tags from the Overview Page
  • Apply a cluster Tag to a New Database Deployment from a Template
  • Apply cluster Tags to a New Database Deployment with Advanced Options
  • Manage cluster Tags When You Modify an Existing Database Deployment

You can add tags to your database deployments to better understand, organize, and identify your database deployments. Categorize your database deployments by purpose, environment, or team. Use tags to help with database deployment management. To learn more, see Database Deployment Management.

Note

These database deployment tags differ from the pre-defined replica set tags that Atlas provides. You can't change those replica set tags. You can provide and manage these database deployment tags.

Important

If you delete a database deployment and the associated tags don't apply to any other database deployment, Atlas deletes the tags.

Database Deployment Tagging Considerations

Before you begin, review the requirements, considerations, best practices, prerequisites, and suggested tags.

Manage cluster Tags from the Database Deployments Page

You can add a tag, view existing tags, and manage tags from the Database Deployments page. To learn more, see Review Database Deployment Metrics.

1

In Atlas, go to the Database Deployments page for your project.

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

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

  3. If the Database Deployments page is not already displayed, click Database in the sidebar.

2

Manage tags.

  1. In the lower-left corner of the database deployment, view any existing tags.

  2. On the database deployment, click Add Tag or Manage tags.

    Important

    Don't include sensitive information such as Personally Identifiable Information (PII) or Protected Health Information (PHI) in your resource tags. Other MongoDB services, such as Billing, can access resource tags. Resource tags are not intended for private and sensitive data. To learn more, see Sensitive Information.

  3. To manage your tags, see Manage Tags.

  4. Click Save.

Manage cluster Tags from the Overview Page

You can add a tag, view existing tags, and manage tags from the Overview page. To learn more, see Review Database Deployment Metrics.

1

In Atlas, go to the Database Deployments page for your project.

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

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

  3. If the Database Deployments page is not already displayed, click Database in the sidebar.

2

Go to the Overview page for your project.

  1. Click View Monitoring.

  2. Click the Overview tab.

3

Manage tags.

  1. In the upper-left corner of the Overview page, view any existing tags.

  2. In the Tags section, click Add Tag or Manage tags.

    Important

    Don't include sensitive information such as Personally Identifiable Information (PII) or Protected Health Information (PHI) in your resource tags. Other MongoDB services, such as Billing, can access resource tags. Resource tags are not intended for private and sensitive data. To learn more, see Sensitive Information.

  3. To manage your tags, see Manage Tags.

  4. Click Save.

Apply a cluster Tag to a New Database Deployment from a Template

You can add a tag, view existing tags, and manage tags when you create a new database deployment from a template. To learn more, see Create a Cluster or Create a Serverless Instance.

1

In Atlas, go to the Database Deployments page for your project.

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

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

  3. If the Database Deployments page is not already displayed, click Database in the sidebar.

2

Specify a tag key and value.

  1. Click Build a Database.

  2. In the Tag section, specify a Key and Value.

    Important

    Don't include sensitive information such as Personally Identifiable Information (PII) or Protected Health Information (PHI) in your resource tags. Other MongoDB services, such as Billing, can access resource tags. Resource tags are not intended for private and sensitive data. To learn more, see Sensitive Information.

Apply cluster Tags to a New Database Deployment with Advanced Options

You can add a tag, view existing tags, and manage tags when you create a new database deployment. To learn more, see Create a Cluster or Create a Serverless Instance.

1

In Atlas, go to the Database Deployments page for your project.

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

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

  3. If the Database Deployments page is not already displayed, click Database in the sidebar.

2

Open the Create New Database Deployment Dialog.

  • If you already have one or more database deployments, click Create to display the Create New Database Deployment dialog.

  • If this is your first database deployment:

    1. Click Build a Database.

    2. Click advanced configuration options at the top of the screen to display the Create New Database Deployment dialog.

3

Manage tags.

  1. In the Cluster Details or Serverless Instance Details section, click Add Tag.

    Important

    Don't include sensitive information such as Personally Identifiable Information (PII) or Protected Health Information (PHI) in your resource tags. Other MongoDB services, such as Billing, can access resource tags. Resource tags are not intended for private and sensitive data. To learn more, see Sensitive Information.

  2. To manage your tags, see Manage Tags.

Manage cluster Tags When You Modify an Existing Database Deployment

You can add a tag, view existing tags, and manage tags when you modify an existing database deployment. To learn more, see Modify a Cluster or Manage Serverless Instances.

1

In Atlas, go to the Database Deployments page for your project.

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

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

  3. If the Database Deployments page is not already displayed, click Database in the sidebar.

2

Go to the database deployment settings.

Click Edit Config and select your cluster in the drop-down menu.

3

Manage tags.

  1. In the Cluster Details or Serverless Instance Details section, click Add Tag.

    Important

    Don't include sensitive information such as Personally Identifiable Information (PII) or Protected Health Information (PHI) in your resource tags. Other MongoDB services, such as Billing, can access resource tags. Resource tags are not intended for private and sensitive data. To learn more, see Sensitive Information.

  2. To manage your tags, see Manage Tags.

Manage Tags

1

Navigate to your resource tags using one of the procedures described on this page.

2

Manage the tag.

Important

Don't include sensitive information such as Personally Identifiable Information (PII) or Protected Health Information (PHI) in your resource tags. Other MongoDB services, such as Billing, can access resource tags. Resource tags are not intended for private and sensitive data. To learn more, see Sensitive Information.

Do any of the following tasks:

  • To add a tag, click Add tag, and specify a Key and Value.

  • To edit a tag, update the Key or Value for the tag.

  • To delete a tag, click the Delete icon next to the tag.

    Note

    If you delete a tag, Atlas removes the tag from the associated resources.

← Resource Tags
Tags on Projects →

On this page