AWS Terraform Naming Conventions

Creating a set of naming conventions for Terraform-managed AWS resources can be a key factor in maintaining consistency, clarity, and scalability within your cloud infrastructure. A good naming convention should provide enough information to identify the resource type, its purpose, environment, and region, while also being unique enough to avoid conflicts.

Below is a suggested naming convention tailored to AWS resources, following a human-readable yet structured approach:

General Principles for Naming AWS Resources in Terraform:

1. Consistency: Use a consistent pattern for all resources.
2. Readability: Ensure names are easily readable and identifiable by humans.
3. Uniqueness: Include elements that make each resource name unique, such as environment names, region codes, or project identifiers.
4. Avoid Special Characters: Stick to alphanumeric characters and dashes (-), avoiding underscores (_) or spaces.
5. Max Length Consideration: AWS has certain limitations for resource names, so keep it concise (usually between 3 and 255 characters depending on the resource).

Structure of Naming Convention

For most resources, a recommended format could look like this:

<project-name>-<environment>-<resource-type>-<region>-<identifier>

Where:

• project-name: Short, meaningful name for the project (e.g., myapp, data-platform, payment-service)
• environment: A code or short name for the environment (e.g., dev, prod, staging, test)
• resource-type: The type of the AWS resource (e.g., s3, ec2, vpc, rds)
• region: AWS region code (e.g., us-east-1, us-west-2, eu-west-1)
• identifier: A unique identifier for the resource (e.g., 01, db1, bucket01).

Examples of Naming Conventions for Common AWS Resources:

S3 Buckets:

<project-name>-<environment>-s3-<region>-<unique-id>

Example: myapp-prod-s3-us-east-1-media

EC2 Instances:

<project-name>-<environment>-ec2-<region>-<instance-id>

Example: data-platform-dev-ec2-us-west-2-web01

RDS Databases:

<project-name>-<environment>-rds-<region>-<db-type>-<unique-id>

Example: payment-service-prod-rds-us-east-1-mysql01

VPC:

<project-name>-<environment>-vpc-<region>-<unique-id>

Example: data-platform-prod-vpc-eu-west-1-01

Lambda Functions:

<project-name>-<environment>-lambda-<region>-<function-name>

Example: myapp-staging-lambda-us-east-1-handler

IAM Roles:

<project-name>-<environment>-iam-<region>-<role-name>

Example: payment-service-prod-iam-us-west-2-admin

Security Groups:

<project-name>-<environment>-sg-<region>-<unique-id>

Example: myapp-dev-sg-us-east-1-web

CloudWatch Log Groups:

<project-name>-<environment>-cwlog-<region>-<log-group-name>

Example: data-platform-prod-cwlog-us-west-2-application

SQS Queues:

<project-name>-<environment>-sqs-<region>-<queue-name>

Example: myapp-staging-sqs-us-east-1-taskqueue

Special Considerations:

1. Environment Naming: Keep environment names short and clear: prod, dev, staging, test. Use qa for Quality Assurance, ci for Continuous Integration environments, or perf for Performance testing environments if applicable.
2. Regions: AWS region codes are typically two-letter country codes followed by a number (e.g., us-east-1, us-west-2, ap-south-1). Ensure the region code is included in the resource name to avoid ambiguity, especially when managing multi-region deployments.
3. Uniqueness: Add a unique identifier where appropriate, such as numbers or descriptive terms, to avoid naming conflicts. For example, in S3 buckets, it's common to add a random suffix or project-specific code.
4. Avoid Redundancy: If the project name and resource type already give enough context, avoid repeating information. For example, avoid myapp-prod-s3-bucket-us-west-2.

Final Thoughts:

With these conventions, you'll not only make it easier to manage your resources but also improve the ability for your team to quickly understand the infrastructure layout. Terraform’s modularity and automation tools will benefit from this clarity, allowing your infrastructure to scale smoothly while adhering to consistent standards.

By applying this simple yet comprehensive structure, your cloud resources will be organized, maintainable, and ready for collaboration. Keep it human-friendly, but also machine-readable!