region_code

Type string
Default null

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

Region Code Conventions

The region code is an optional identifier that helps distinguish resources deployed across multiple AWS regions. This is particularly useful for multi-region architectures and disaster recovery setups.

Common Region Codes

AWS RegionCodeDescription
us-east-1use1N. Virginia
us-east-2use2Ohio
us-west-1usw1N. California
us-west-2usw2Oregon
eu-west-1euw1Ireland
eu-west-2euw2London
eu-central-1euc1Frankfurt
ap-southeast-1apse1Singapore
ap-northeast-1apne1Tokyo

When to Use

Include region codes when:

  • Deploying resources across multiple regions
  • Implementing active-active or active-passive architectures
  • Resources need to be uniquely identifiable across regions
  • Cross-region resource references are common

Best Practices

  • Set to null for single-region deployments to keep names shorter
  • Use consistent abbreviation patterns across all regions
  • Document your region code mappings in a central location
  • Consider alphabetical sorting when choosing code formats

Full Module Example

module "naming_convention" {
  source  = "registry.patterneddesigns.ca/standardnat/naming-convention/aws"
  version = "0.1.0"

  # region_code
  region_code = "..."

  # Other required inputs
  environment = "..."
  project = "..."
}