-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(standard): add resource tagging standard
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
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) |