Terraform Guidelines¶

Style Guide¶

The official style guide is provided by Terraform. As a rule, please adhere to the following document:

Style Guide - Configuration Language | Terraform | HashiCorp Developer

Naming Conventions for AWS Resources¶

Please follow the guidelines below for naming AWS resources.

Components of the Name¶

• {product}: Product name (e.g., oqtopus)
• {org}: Organization name (e.g., example)
• {env}: Environment name (e.g., dev, stg, prd)
• {identifier}: Identifier (e.g., user, provider)

Principles¶

Unless there is an exception, resource names should follow the format below:

{product}-{org}-{env}-{identifier}-{name}

For example, in the case of a Lambda function for the USER API, it would look like this:

oqtopus-example-user-api

References¶

• Future Enterprise Naming Convention Standards for AWS infrastructure resource