Patterned Designs HCL Module Registry
MODULE

naming-convention

standardnat/naming-convention/aws
v0.1.0 latest View all versions

Terraform module for naming-convention on aws

View Full Documentation Usage guides, examples & best practices
module "naming-convention" {
  source  = "registry.patterneddesigns.ca/standardnat/naming-convention/aws"
  version = "0.1.0"
}
environment required
string

Environment identifier for resource naming (e.g., dev, stg, prod, sbx, qa)

Constraints
  • Environment must be lowercase alphanumeric characters only.
  • Environment must be between 2 and 10 characters.
project required
string

Project or application name for resource identification

Constraints
  • Project name must use lowercase alphanumeric characters and hyphens only.
  • Project name must be between 2 and 32 characters.
region_code
string default: null

Optional region code for multi-region deployments (e.g., use1, euw1, apse1)

Constraints
  • Region code must be lowercase alphanumeric characters only.
  • Region code must be between 3 and 8 characters when specified.
separator
string default: -

Character used to separate name components (default: hyphen for maximum compatibility)

Constraints
  • Separator must be one of: hyphen (-), underscore (_), or period (.).
tags
map(string) default: null

Additional tags to merge with generated tags

prefix

Generated naming prefix for resources (combines environment, project, and optional region_code)

tags

Standard tags derived from naming convention inputs

id

Unique identifier for the naming context

← Back to Home Machine-readable specification