Terraform.workspace interpolation - Mini Project: Build & Apply

Using Terraform.workspace Interpolation

📖 Scenario: You are managing infrastructure for multiple environments like development and production. You want to use Terraform to create resources that change based on the current workspace.

🎯 Goal: Build a Terraform configuration that uses terraform.workspace interpolation to set resource names dynamically depending on the active workspace.

📋 What You'll Learn

Create a Terraform variable to hold a base resource name

Define a local value that combines the base name with the current workspace using terraform.workspace

Create an AWS S3 bucket resource using the combined name

Add a tag to the bucket that shows the current workspace

💡 Why This Matters

🌍 Real World

Terraform workspaces help manage multiple environments like dev, test, and prod using the same configuration but different resource names.

💼 Career

Cloud engineers use <code>terraform.workspace</code> interpolation to write reusable infrastructure code that adapts to different deployment environments.

1

Create a Terraform variable for the base resource name

Create a Terraform variable called base_name with the default value myapp.

Terraform

# Your code here

Hint

Use the variable block with default set to "myapp".

2

Define a local value combining base_name and terraform.workspace

Add a locals block with a local value called bucket_name that combines var.base_name and terraform.workspace separated by a dash.

Terraform

variable "base_name" {
  type    = string
  default = "myapp"
}

# Your code here

Hint

Use locals block and string interpolation with var.base_name and terraform.workspace.

3

Create an AWS S3 bucket resource using the local bucket_name

Create a resource block aws_s3_bucket named example with the bucket name set to local.bucket_name.

Terraform

variable "base_name" {
  type    = string
  default = "myapp"
}

locals {
  bucket_name = "${var.base_name}-${terraform.workspace}"
}

# Your code here

Hint

Use resource "aws_s3_bucket" "example" and set bucket = local.bucket_name.

4

Add a tag to the bucket showing the current workspace

Inside the aws_s3_bucket.example resource, add a tags block with a tag Environment set to terraform.workspace.

Terraform

variable "base_name" {
  type    = string
  default = "myapp"
}

locals {
  bucket_name = "${var.base_name}-${terraform.workspace}"
}

resource "aws_s3_bucket" "example" {
  bucket = local.bucket_name

  # Your code here
}

Hint

Add a tags block with Environment = terraform.workspace inside the resource.

Practice

1. What does terraform.workspace return when used inside a Terraform configuration?

easy

A. The name of the current workspace as a string

B. The current Terraform version

C. The list of all workspaces

D. The current directory path

Solution

1. Step 1: Understand the purpose of terraform.workspace

   terraform.workspace is a built-in Terraform variable that returns the name of the workspace currently in use.

2. Step 2: Identify what terraform.workspace returns

   It returns a string representing the workspace name, which helps differentiate environments.

3. Final Answer:

   The name of the current workspace as a string -> Option A

4. Quick Check:

   terraform.workspace = current workspace name [OK]

Hint: Remember: terraform.workspace always gives current workspace name [OK]

Common Mistakes:

• Thinking it returns Terraform version
• Confusing it with list of all workspaces
• Assuming it returns file paths

2. Which of the following is the correct syntax to use terraform.workspace inside a resource name in Terraform?

easy

A. name = myapp.${terraform.workspace}

B. name = "myapp-${terraform.workspace}"

C. name = 'myapp-terraform.workspace'

D. name = "myapp.terraform.workspace"

Solution

1. Step 1: Understand string interpolation syntax in Terraform

   Terraform uses ${} inside double quotes to insert variable values into strings.

2. Step 2: Identify correct usage of terraform.workspace

   The correct syntax is "myapp-${terraform.workspace}" to append the workspace name.

3. Final Answer:

   name = "myapp-${terraform.workspace}" -> Option B

4. Quick Check:

   Use ${} inside double quotes for interpolation [OK]

Hint: Use ${terraform.workspace} inside double quotes for interpolation [OK]

Common Mistakes:

• Using single quotes which disable interpolation
• Missing ${} around terraform.workspace
• Using dot notation without quotes

3. Given the Terraform code snippet:

output "env_name" {
  value = "Current workspace is: ${terraform.workspace}"
}

If the active workspace is staging, what will be the output value?

medium

A. An error occurs because output cannot use terraform.workspace

B. "Current workspace is: default"

C. "Current workspace is: production"

D. "Current workspace is: staging"

Solution

1. Step 1: Understand output interpolation with terraform.workspace

   The output value uses string interpolation to insert the current workspace name.

2. Step 2: Substitute the active workspace name

   Since the active workspace is staging, the output string becomes "Current workspace is: staging".

3. Final Answer:

   "Current workspace is: staging" -> Option D

4. Quick Check:

   Output string includes current workspace name [OK]

Hint: Replace ${terraform.workspace} with active workspace name [OK]

Common Mistakes:

• Assuming default workspace always
• Thinking terraform.workspace cannot be used in outputs
• Confusing workspace names

4. You wrote this Terraform resource name:

resource "aws_s3_bucket" "example" {
  bucket = 'mybucket-${terraform.workspace}'
}

But when you run Terraform, you get an error: Invalid reference. What is the likely cause?

medium

A. terraform.workspace is not available in resource blocks

B. terraform.workspace must be assigned to a variable first

C. You used single quotes instead of double quotes around the bucket name

D. You forgot to initialize Terraform workspaces

Solution

1. Step 1: Check string interpolation rules in Terraform

   Terraform requires double quotes for string interpolation; single quotes treat content as literal.

2. Step 2: Identify the error cause

   If single quotes were used, ${terraform.workspace} is not evaluated, causing an invalid reference error.

3. Final Answer:

   You used single quotes instead of double quotes around the bucket name -> Option C

4. Quick Check:

   Use double quotes for interpolation [OK]

Hint: Always use double quotes for strings with ${} interpolation [OK]

Common Mistakes:

• Using single quotes disables interpolation
• Assuming terraform.workspace needs variable assignment
• Not initializing workspaces but error is different

5. You want to create two S3 buckets using the same Terraform code but different names per workspace. You write:

resource "aws_s3_bucket" "bucket1" {
  bucket = "app-${terraform.workspace}"
}

resource "aws_s3_bucket" "bucket2" {
  bucket = "app-${terraform.workspace}"
}

What problem will occur when you apply this configuration in the dev workspace?

hard

A. Terraform will create two buckets with the same name, causing a conflict

B. Terraform will create only one bucket named "app-dev"

C. Terraform will fail because terraform.workspace cannot be used twice

D. Terraform will create buckets with different names automatically

Solution

1. Step 1: Analyze bucket names generated

   Both resources use the same bucket name pattern: "app-${terraform.workspace}". In the dev workspace, both names become "app-dev".

2. Step 2: Understand AWS S3 bucket naming constraints

   S3 bucket names must be unique globally. Creating two buckets with the same name causes a conflict error.

3. Final Answer:

   Terraform will create two buckets with the same name, causing a conflict -> Option A

4. Quick Check:

   Duplicate resource names cause conflicts [OK]

Hint: Ensure unique names per resource even with terraform.workspace [OK]

Common Mistakes:

• Assuming terraform.workspace makes names unique per resource
• Thinking Terraform merges resources automatically
• Believing terraform.workspace cannot be used multiple times