tagging-policy | Patterned Designs Documentation

Overview

The tagging-policy module establishes and enforces consistent tagging standards across your AWS resources, enabling effective cost allocation, resource ownership tracking, and compliance management.

Define required tags that must be present on all resources
Set organization-wide default tag values
Generate validation rules for policy enforcement
Optionally enforce lowercase tag values for consistency

Category: Standards Provider: AWS Latest Version: 1.1.0

Quick Start

module "tags" {
  source  = "registry.patterneddesigns.ca/standardnat/tagging-policy/aws"
  version = "1.1.0"

  required_tags = ["Environment", "Owner", "CostCenter", "Project"]

  default_tags = {
    ManagedBy  = "terraform"
    Repository = "infrastructure"
  }

  enforce_lowercase = true
}

# Apply to all resources
provider "aws" {
  default_tags {
    tags = module.tags.merged_tags
  }
}

Key Features

Required Tags

Define mandatory tags that must be present on all resources:

module "tags" {
  source  = "registry.patterneddesigns.ca/standardnat/tagging-policy/aws"
  version = "1.1.0"

  required_tags = [
    "Environment",
    "Owner",
    "CostCenter",
    "Project",
    "Application"
  ]
}

Default Tag Values

Set organization-wide defaults that apply automatically:

module "tags" {
  source  = "registry.patterneddesigns.ca/standardnat/tagging-policy/aws"
  version = "1.1.0"

  required_tags = ["Environment", "Owner"]

  default_tags = {
    ManagedBy    = "terraform"
    Organization = "acme-corp"
    Repository   = "infrastructure"
    CreatedBy    = "platform-team"
  }
}

Case Normalization

Enforce consistent lowercase tag values:

module "tags" {
  source  = "registry.patterneddesigns.ca/standardnat/tagging-policy/aws"
  version = "1.1.0"

  required_tags     = ["Environment", "Owner"]
  enforce_lowercase = true

  default_tags = {
    Environment = "PRODUCTION"  # Normalized to "production"
  }
}

Documentation

Inputs - All input parameters
Outputs - Output values
Examples - Usage examples
Use Cases - Real-world scenarios

Registry

View specification on Registry

Inputs

required_tags

list(string)

List of tag keys that must be present on all resources

default_tags

map(string)

Default tag values applied to all resources

enforce_lowercase

bool

Enforce lowercase tag values for consistency

tag_values

map(list(string))

Allowed values for specific tag keys. Define constraints for tags that have a limited set of valid options (e.g., Environment = ["dev", "staging", "prod"]).

additional_tags