Output declaration syntax in Terraform - Mini Project: Build & Apply

Output declaration syntax

📖 Scenario: You are managing cloud infrastructure using Terraform. You want to share important information about your resources after deployment, such as IP addresses or resource IDs, so other team members or tools can use them easily.

🎯 Goal: Create a Terraform configuration that defines a resource and then declares an output to show a specific attribute of that resource after deployment.

📋 What You'll Learn

Create a Terraform resource block for an AWS EC2 instance named example_instance with the AMI ID ami-12345678 and instance type t2.micro.

Declare an output named instance_id that outputs the ID of the example_instance.

Use the correct Terraform output declaration syntax.

💡 Why This Matters

🌍 Real World

Outputs in Terraform are used to share important information about deployed resources with other team members, automation tools, or subsequent Terraform configurations.

💼 Career

Knowing how to declare and manage outputs is essential for cloud engineers and DevOps professionals to create reusable and maintainable infrastructure code.

1

Create the AWS EC2 instance resource

Create a Terraform resource block named example_instance of type aws_instance with ami set to "ami-12345678" and instance_type set to "t2.micro".

Terraform

# Your code here

Hint

Use the resource block with the resource type aws_instance and name example_instance. Set the ami and instance_type attributes exactly as specified.

2

Add an output block declaration

Add a Terraform output block named instance_id with a value set to the ID of the example_instance resource using aws_instance.example_instance.id.

Terraform

resource "aws_instance" "example_instance" {
  ami           = "ami-12345678"
  instance_type = "t2.micro"
}

# Your code here

Hint

Use the output block with the name instance_id. Set the value attribute to aws_instance.example_instance.id to output the instance ID.

3

Add a description to the output

Inside the instance_id output block, add a description attribute with the text "The ID of the example instance".

Terraform

resource "aws_instance" "example_instance" {
  ami           = "ami-12345678"
  instance_type = "t2.micro"
}

output "instance_id" {
  value = aws_instance.example_instance.id
  # Your code here
}

Hint

Add the description attribute inside the output block to explain what the output represents.

4

Add a sensitive flag to the output

In the instance_id output block, add the attribute sensitive = true to mark the output as sensitive.

Terraform

resource "aws_instance" "example_instance" {
  ami           = "ami-12345678"
  instance_type = "t2.micro"
}

output "instance_id" {
  description = "The ID of the example instance"
  value       = aws_instance.example_instance.id
  # Your code here
}

Hint

Add sensitive = true inside the output block to hide the output value from normal display.

Practice

1. What is the purpose of an output block in a Terraform configuration?

easy

A. To display useful information after Terraform applies changes

B. To define variables for input values

C. To create resources in the cloud

D. To delete resources automatically

Solution

1. Step 1: Understand Terraform output blocks

   Output blocks are used to show important information after Terraform finishes applying infrastructure changes.

2. Step 2: Differentiate from other blocks

   Variables define inputs, resources create cloud items, and outputs only display results.

3. Final Answer:

   To display useful information after Terraform applies changes -> Option A

4. Quick Check:

   Output block = display info [OK]

Hint: Outputs show info after apply, not inputs or resource creation [OK]

Common Mistakes:

• Confusing outputs with variables
• Thinking outputs create resources
• Assuming outputs delete resources

2. Which of the following is the correct syntax to declare an output named instance_ip with value aws_instance.web.private_ip?

easy

A. output "instance_ip" { value = aws_instance.web.private_ip }

B. output instance_ip = aws_instance.web.private_ip

C. output "instance_ip" : aws_instance.web.private_ip

D. output instance_ip { value: aws_instance.web.private_ip }

Solution

1. Step 1: Recall Terraform output block syntax

   The correct syntax uses the keyword output, a quoted name, and a block with value assignment using =.

2. Step 2: Check each option

   output "instance_ip" { value = aws_instance.web.private_ip } matches the correct syntax exactly. Others use invalid assignment or missing quotes.

3. Final Answer:

   output "instance_ip" { value = aws_instance.web.private_ip } -> Option A

4. Quick Check:

   Output syntax = output "name" { value = ... } [OK]

Hint: Output name must be quoted and value assigned with = inside braces [OK]

Common Mistakes:

• Omitting quotes around output name
• Using = outside braces
• Using colon instead of =

3. Given this output block:

output "db_password" {
  value     = var.db_password
  sensitive = true
}

What will Terraform do when you run terraform apply?

medium

A. Cause a syntax error because sensitive is not allowed

B. Show the db_password value in the output after apply

C. Hide the db_password value in the output to keep it secret

D. Ignore the output block completely

Solution

1. Step 1: Understand the sensitive attribute

   Setting sensitive = true tells Terraform to hide the output value from the terminal to protect secrets.

2. Step 2: Predict Terraform behavior on apply

   Terraform will not display the actual value but will note that a sensitive output exists.

3. Final Answer:

   Hide the db_password value in the output to keep it secret -> Option C

4. Quick Check:

   sensitive = true hides output value [OK]

Hint: Sensitive outputs hide values after apply to protect secrets [OK]

Common Mistakes:

• Expecting sensitive outputs to show values
• Thinking sensitive causes errors
• Assuming outputs are ignored

4. Identify the error in this output block:

output "server_port" {
  value = 8080
  sensitive = "false"
}

medium

A. The value 8080 must be a string, not a number

B. The sensitive attribute should be a boolean, not a string

C. Output names cannot be quoted

D. Missing a comma after the value line

Solution

1. Step 1: Check attribute types in output block

   The sensitive attribute expects a boolean (true or false), not a string in quotes.

2. Step 2: Validate other parts

   Value can be a number without quotes, output names must be quoted, and commas are not used between lines in HCL.

3. Final Answer:

   The sensitive attribute should be a boolean, not a string -> Option B

4. Quick Check:

   sensitive = true/false boolean, not "false" string [OK]

Hint: Boolean attributes must not be quoted strings [OK]

Common Mistakes:

• Using quotes around boolean values
• Thinking output names are unquoted
• Adding commas between lines

5. You want to output a list of public IPs from multiple AWS instances stored in aws_instance.web list. Which output block correctly returns their public IPs?

hard

A. output "public_ips" { value = for i in aws_instance.web { i.public_ip } }

B. output "public_ips" { value = aws_instance.web.public_ip }

C. output "public_ips" { value = aws_instance.web.public_ip[*] }

D. output "public_ips" { value = [for i in aws_instance.web : i.public_ip] }

Solution

1. Step 1: Understand how to extract values from a list of resources

   Terraform uses for-expressions inside output value to map over lists and extract attributes.

2. Step 2: Evaluate each option

   output "public_ips" { value = [for i in aws_instance.web : i.public_ip] } uses correct for-expression syntax. output "public_ips" { value = aws_instance.web.public_ip } tries direct attribute access on list (invalid). output "public_ips" { value = aws_instance.web.public_ip[*] } uses incorrect splat syntax. output "public_ips" { value = for i in aws_instance.web { i.public_ip } } has invalid block syntax.

3. Final Answer:

   output "public_ips" { value = [for i in aws_instance.web : i.public_ip] } -> Option D

4. Quick Check:

   Use for-expressions to map list attributes [OK]

Hint: Use for-expressions with [for x in list : x.attr] to extract lists [OK]

Common Mistakes:

• Trying to access attribute directly on list
• Using invalid syntax for list comprehension
• Confusing for-expression with block syntax