Outputs as documentation in Terraform - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ service_behavior

intermediate

What is the output value of this Terraform output block?

Given the following Terraform output configuration, what will be the value shown after applying the configuration?

output "instance_ip" {
  value = aws_instance.web.public_ip
  description = "The public IP address of the web server instance"
}

Terraform

output "instance_ip" {
  value = aws_instance.web.public_ip
  description = "The public IP address of the web server instance"
}

A The instance ID of the aws_instance named 'web'

B The private IP address of the aws_instance named 'web'

C The public IP address string of the aws_instance named 'web' after deployment

D An error because description is not allowed in output blocks

💡 Hint

Think about what the 'value' field in an output block represents.

The output block's 'value' field defines what Terraform will show after applying. Here, it outputs the public IP of the instance named 'web'. The description is allowed and helps document the output.

🧠 Conceptual

intermediate

Why use output descriptions in Terraform?

Which of the following best explains the purpose of adding a description to a Terraform output block?

A To change the output value dynamically during apply

B To provide human-readable information about the output for users and maintainers

C To encrypt the output value automatically

D To prevent the output from being displayed after apply

💡 Hint

Think about what descriptions usually do in documentation.

Descriptions in output blocks serve as documentation. They help users understand what the output represents without affecting the output value or behavior.

❓ Configuration

advanced

Which output block correctly documents and outputs the instance ID as a sensitive value?

Select the Terraform output block that outputs the instance ID of 'aws_instance.app' and marks it as sensitive with a clear description.

A

output "app_instance_id" {
  value = aws_instance.app.id
  sensitive = true
  description = "Sensitive instance ID of the app server"
}

B

output "app_instance_id" {
  value = aws_instance.app.id
  sensitive = yes
  description = "Sensitive instance ID of the app server"
}

C

output "app_instance_id" {
  value = aws_instance.app.id
  description = "Sensitive instance ID of the app server"
  sensitive = "true"
}

D

output "app_instance_id" {
  value = aws_instance.app.id
  sensitive = false
  description = "Sensitive instance ID of the app server"
}

💡 Hint

Check the correct syntax and data types for the 'sensitive' argument.

The 'sensitive' argument must be a boolean true or false without quotes. Option A correctly marks the output as sensitive and includes a description.

✅ Best Practice

advanced

Which practice improves output documentation clarity in Terraform?

Which option best improves the clarity and usefulness of Terraform outputs for team members?

A Add clear descriptions to all outputs explaining what they represent and their format

B Only output raw resource IDs without descriptions to keep outputs minimal

C Use outputs only for internal Terraform modules, not for external use

D Avoid using outputs to prevent exposing any resource information

💡 Hint

Think about how documentation helps teams understand infrastructure.

Adding clear descriptions to outputs helps team members understand what each output means and how to use it, improving collaboration and reducing errors.

❓ Architecture

expert

How does output documentation affect multi-environment Terraform deployments?

In a Terraform setup managing multiple environments (dev, staging, prod), how does well-documented outputs help architects and operators?

A It automatically syncs outputs between environments without manual intervention

B It encrypts outputs differently per environment to enhance security

C It disables outputs in non-production environments to save resources

D It helps quickly identify which outputs correspond to which environment and their purpose, reducing mistakes during deployments

💡 Hint

Think about how documentation helps when managing many similar setups.

Clear output documentation helps teams distinguish outputs per environment and understand their roles, which is critical in complex multi-environment deployments.