Configure Resource Tags
You can use resource tags to categorize resources by purpose,
environment, team, or billing center. You can add tags to your
database deployments to better
understand, organize, and identify your database deployments. A
key-value pair makes up each tag. For example, you might add an
environment : production tag. In this example, you set the tag key
to environment and you set the tag value to production. You can
manage resource tags from the Atlas UI, Atlas Administration API, and
Atlas CLI.
Note
These resource 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 resource tags.
Requirements
The following requirements apply to resource 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.
You can have a maximum of 50 tags per database deployment.
Each tag must contain a key and a value.
Each tag key can have a maximum of 255 characters.
Each tag key must be unique.
Each tag value can have a maximum of 255 characters.
Each tag can contain only the following allowable characters:
letters
numbers
spaces
colons (:)
semi-colons (;)
at symbols (@)
underscores (_)
dashes (-)
periods (.)
plus signs (+)
Considerations
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.
Add tags (key-value pairs) to your resources to better understand, organize, and identify your resources.
Use tags to categorize resources by purpose, environment, team, or billing center.
Cluster labels will be deprecated in a future release. We strongly recommend that you use resource tags instead.
Tags keys and tag values are case sensitive. For example, Atlas accepts both
environmentandEnvironmentas separate tag keys.If you delete a tag, Atlas removes the tag from the associated resources.
Whenever a user adds, modifies, or deletes a resource tag, Atlas reflects the event in the Project Activity Feed.
Best Practices
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.
Use a standardized, case-sensitive format for tags, and apply it consistently across all resource types.
Create a tagging strategy that uses standard tags across all of your resource types.
Apply tags for cost allocation. Use a consistent tag key, such as cost-center or billing-unit, to associate related resources based on the billing entity or purpose. Doing so can help you perform cost allocation based on custom dimensions. To learn more, see Resource Tags on Invoices.
Apply tags for resource organization. Use a consistent tag key, such as
environment,application,team, orowner, to group resources.Use the Atlas Administration API to programmatically manage tags across your resources.
Prerequisites
To create or modify resource tags, you must have the
the Project Owner role for the project or the
Organization Owner role on its parent organization.
Next Steps
To add tags to your database deployments, see Configure Database Deployment Tags.