Skip to content

Commit

Permalink
docs(standard): add resource tagging standard
Browse files Browse the repository at this point in the history
Add resource tagging standard
  • Loading branch information
brianpham committed Sep 25, 2024
1 parent 1ae18ee commit 6968dbb
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/style/resource-tagging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Resource Tagging Conventions

Reference
https://docs.aws.amazon.com/whitepapers/latest/establishing-your-cloud-foundation-on-aws/tagging-standards.html
https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html
https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html

## Standard Default Tags

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

- 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

Example:

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

## Tagging Dictionary

0 comments on commit 6968dbb

Please sign in to comment.