NYU S3 Naming Convention Overview
Naming conventions ensure the name of each S3 bucket is unique while allowing useful information to be deduced from the names.
Syntax
- All characters are strictly lower case
- Remove whitespace from values
- Separate values with dashes
- Must conform to Amazon S3 bucket naming requirements and best practices
Convention
- Naming convention: university-environment-supportgroup-universityservice-function
- Example: nyu-dev-edm-learninganalytics-data
| Value | Value Examples | Description | Character limit | Required |
|---|---|---|---|---|
| university | nyu | Identify NYU as the owner of the bucket.
Benefit: Buckets can be accessed from anywhere, including external to the university if permissions are properly granted. This clearly identifies the bucket as belonging to NYU. |
3 | Yes |
| environment |
|
Designate the production level of the associated AWS resource.
Benefit: Provides a way to delineate the relative importance of different AWS resources. |
5 | Yes |
| supportgroup |
|
Name used for the group responsible for supporting the system.
This should match what’s listed in the ServiceLink for the University Service, abbreviated as necessary to meet the 10 character limit for this value. |
10 | Yes |
| universityservice |
|
The universityservice key shall be used to designate the application or University Service of the associated AWS resource. In this capacity “application” does not refer to an installed software component, but rather the overall business application that the resource supports.
This should match what’s listed in the ServiceLink CI for the University Service, abbreviated as necessary to meet the 15 character limit for this value. |
20 | Yes |
| function |
|
Describes the purpose of the bucket, defined by the app owner. Append a number if multiple buckets are required for the same function (e.g. images001, images002).
Benefit: Indicates what the bucket is being used for and provides a unique identifier. |
10 | Yes |