1.2.3.1. Terraform Output Values File

The outputs.tf file is one of the four mandatory files (main.tf/variables.tf/outputs.tf/terraform.tf) that we must discuss as part of any module structure, and it contains only Terraform output value declarations. Even if a module has no output blocks, it should still maintain an outputs.tf file. Multiple output files are allowed, but their filenames must contain outputs, for example: outputs_db.tf or db_outputs.tf. Additionally, these outputs.tf files should contain only output blocks.

If we compare a module to a function, then outputs.tf represents the function's return value list (this is a function that supports multi-value returns). A well-designed module should follow certain output value conventions:

1.2.3.1.1. output declarations should be sorted alphabetically

1.2.3.1.2. output naming and description should align as closely as possible with the description of related parameters in the resource documentation

1.2.3.1.3. output blocks containing sensitive data should declare sensitive = true

1.2.3.1.4. There should be one blank line between two output blocks