tags

Type map(string)
Default null

Additional tags to merge with generated tags

Tag Merging

The module generates standard tags based on the naming convention inputs. You can provide additional tags that will be merged with the generated ones.

Generated Tags

The module automatically generates these tags:

Tag KeySourceExample Value
Environmentenvironment inputprod
Projectproject inputmyapp
Regionregion_code inputuse1
ManagedByAuto-generatedterraform

Custom Tags

Add additional tags for your organization’s requirements:

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

  environment = "prod"
  project     = "myapp"

  tags = {
    CostCenter  = "engineering"
    Owner       = "platform-team"
    Compliance  = "pci-dss"
  }
}

Best Practices

  • Use consistent tag key naming (PascalCase or lowercase)
  • Include cost allocation tags for billing analysis
  • Add owner and contact information tags
  • Consider compliance and security classification tags
  • Document required tags in your organization’s standards

Full Module Example

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

  # tags
  tags = "..."

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