environment
RequiredEnvironment identifier for resource naming (e.g., dev, stg, prod, sbx, qa)
Environment Naming
The environment identifier is a required component that helps distinguish resources across different deployment stages. Common conventions include short codes for clarity.
Recommended Values
| Environment | Value | Description |
|---|---|---|
| Development | dev | Development and testing |
| Staging | stg | Pre-production validation |
| Production | prod | Live production workloads |
| Sandbox | sbx | Experimental environments |
| Quality Assurance | qa | QA testing environment |
Best Practices
- Use short, consistent abbreviations (3-4 characters)
- Avoid environment names that could be confused (e.g.,
testvstst) - Keep environment names lowercase for consistency
- Document your environment naming conventions in a central location
- Consider using environment identifiers that sort alphabetically in a logical order
Full Module Example
module "naming_convention" {
source = "registry.patterneddesigns.ca/standardnat/naming-convention/aws"
version = "0.1.0"
# environment
environment = "..."
# Other required inputs
project = "..."
}