project
RequiredProject or application name for resource identification
Project Naming
The project name identifies the application or service that owns the resource. This is a required field that forms the core of your resource naming structure.
Naming Patterns
- Application-based:
myapp,userservice,paymentapi - Team-based:
platform,data-eng,security - Product-based:
storefront,analytics,notifications
Validation Rules
Project names should follow these guidelines:
- Use lowercase alphanumeric characters
- Use hyphens to separate words (no underscores or spaces)
- Keep names concise but descriptive (5-20 characters)
- Avoid abbreviations that aren’t widely understood
Best Practices
- Establish a project naming registry to prevent duplicates
- Use names that are meaningful to both technical and business stakeholders
- Avoid including environment or region in the project name (use dedicated fields)
- Consider how the name will appear in AWS Console and CLI output
Full Module Example
module "naming_convention" {
source = "registry.patterneddesigns.ca/standardnat/naming-convention/aws"
version = "0.1.0"
# project
project = "..."
# Other required inputs
environment = "..."
}