Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(standard): add resource tagging standard #41

Merged
merged 1 commit into from
Oct 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/style/resource-tagging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Resource Tagging Conventions

## Standard Default Tags

These are the default standard tags that are created and expected through our metadata module. Standard default tags are always proper case and allow them to be visualized in the AWS console.

- Component
- Contact
- Description
- Domain
- Environments
- Organization
- System
- Team

## General Convention For New Tags

For tags that are not the standard default tags, use the following convention:

1. Use kebab case follow by colon
brianpham marked this conversation as resolved.
Show resolved Hide resolved
2. Use lowercase for all the words
3. Use `:` to help identify that the resource is associated with the prefix
4. Should not contain any personal identifiable information (PII)

Example:

```aws
backup:required = true
backup:enabled = true
pii = true
pii:description = some description
pii:contact-team = platform
pii:contact = [email protected]
```

## Reference

- [What Are Tags?](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html)
- [Tagging Best Practices](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html)
- [Tagging Standards](https://docs.aws.amazon.com/whitepapers/latest/establishing-your-cloud-foundation-on-aws/tagging-standards.html)
Loading