Naming Conventions

Table of Contents

Overview

This document defines the naming conventions for all resources and artifacts created by the VPC Provisioner Tool.

Configuration Variables

All naming patterns use these variables from the configuration file:

  • {company_prefix} — Company identifier (e.g., edge)

  • {env} — Environment (e.g., prod, dev, staging)

  • {tenant_id} — Tenant identifier (e.g., b001)

  • {region} — AWS region (e.g., us-west-2)

The stem is the base name prefix used across all resources and files. Every resource the tool creates starts with this stem, making it easy to identify and manage all artifacts from a single deployment.

Stem pattern: {company_prefix}-{env}-{tenant_id}-{region}-vpc

Stem examples:

  • edge-prod-b001-us-west-2-vpc

  • acme-dev-a003-us-east-1-vpc

  • tech-staging-c001-eu-west-1-vpc

For example, if your stem is edge-prod-b001-us-west-2-vpc, then:

  • Your stack is named edge-prod-b001-us-west-2-vpc-stack

  • Your template file is edge-prod-b001-us-west-2-vpc-template.yaml

  • Your IAM policy file is edge-prod-b001-us-west-2-vpc-iam-policy.json

  • Your log files start with edge-prod-b001-us-west-2-vpc-

AWS Resources

VPC (Regional)

Auto-generated pattern: {stem}

Examples:

  • edge-prod-b001-us-west-2-vpc

  • acme-dev-a003-us-east-1-vpc

Custom names: When vpc_name_override is set, the custom name is used instead.

CloudFormation Stack (Regional)

Pattern: {stem}-stack

Examples:

  • edge-prod-b001-us-west-2-vpc-stack

  • acme-dev-a003-us-east-1-vpc-stack

IAM Policy (Global)

Pattern: {stem}-iam-policy

Examples:

  • edge-prod-b001-us-west-2-vpc-iam-policy

  • acme-dev-a003-us-east-1-vpc-iam-policy

Subnets (Regional)

Pattern: {type}-subnet-{az_suffix}

Subnet names are derived from the subnet type and availability zone:

Type

Example

Public

public-subnet-1a, public-subnet-1b

Private App

private-app-subnet-1a, private-app-subnet-1b

Database

database-subnet-1a, database-subnet-1b

Network Resources (Regional)

Resource

Pattern

Example

Internet Gateway

{stem}-igw

edge-prod-b001-us-west-2-vpc-igw

NAT Gateway

{stem}-nat-{az}

edge-prod-b001-us-west-2-vpc-nat-1a

Elastic IP

{stem}-eip-{az}

edge-prod-b001-us-west-2-vpc-eip-1a

Route Table

{stem}-{type}-rt

edge-prod-b001-us-west-2-vpc-public-rt

System Tags

The tool automatically applies system tags to all resources:

Tag Key

Source

CompanyName

client.company_name

CompanyPrefix

client.company_prefix

TenantId

client.tenant_id

Environment

client.environment

Region

client.region

ManagedBy

vpc-provisioner

CreatedDate

Auto-generated timestamp

Local Artifacts

Configuration Files

Pattern: {stem}.yaml

Location: vpc/configs/

Examples:

  • edge-prod-b001-us-west-2-vpc.yaml

  • acme-dev-a003-us-east-1-vpc.yaml

CloudFormation Templates

Pattern: {stem}-template.yaml

Location: vpc/templates/

Examples:

  • edge-prod-b001-us-west-2-vpc-template.yaml

  • acme-dev-a003-us-east-1-vpc-template.yaml

IAM Policy Files

Pattern: {stem}-iam-policy.json

Location: vpc/reports/

Examples:

  • edge-prod-b001-us-west-2-vpc-iam-policy.json

  • acme-dev-a003-us-east-1-vpc-iam-policy.json

Traffic Assumptions Files

Pattern: {stem}-traffic.yaml

Location: vpc/configs/

Examples:

  • edge-prod-b001-us-west-2-vpc-traffic.yaml

  • acme-dev-a003-us-east-1-vpc-traffic.yaml

Log Files

Pattern: {stem}-{action}-{timestamp}.log

Location: vpc/reports/

Examples:

  • edge-prod-a001-us-west-2-vpc-create-policy-20260224_173327_277.log

  • edge-prod-a001-us-west-2-vpc-create-vpc-20260224_174156_473.log

HTML Reports

Pattern: {stem}-{action}-{timestamp}.html

Location: vpc/reports/

Examples:

  • edge-prod-a001-us-west-2-vpc-create-prov-template-20260224_173643_921.html

Naming Convention Summary

Resource

Pattern

VPC

{stem}

CloudFormation Stack

{stem}-stack

IAM Policy

{stem}-iam-policy

Internet Gateway

{stem}-igw

NAT Gateway

{stem}-nat-{az}

Elastic IP

{stem}-eip-{az}

Route Table

{stem}-{type}-rt

Config File

{stem}.yaml

Template File

{stem}-template.yaml

Policy File

{stem}-iam-policy.json

Traffic File

{stem}-traffic.yaml

Log File

{stem}-{action}-{timestamp}.log

HTML Report

{stem}-{action}-{timestamp}.html

Where stem is {company_prefix}-{env}-{tenant_id}-{region}-vpc.