Terraform.workspace interpolation - Step-by-Step Execution

Process Flow - Terraform.workspace interpolation

Start Terraform run

↓

Detect current workspace

↓

Interpolate ${terraform.workspace}

↓

Use workspace name in config

↓

Apply config with workspace-specific values

↓

End

Terraform detects the current workspace, replaces ${terraform.workspace} with its name, and applies configuration accordingly.

Execution Sample

Terraform

resource "aws_s3_bucket" "example" {
  bucket = "myapp-${terraform.workspace}-bucket"
  acl    = "private"
}

Creates an S3 bucket with a name that includes the current Terraform workspace.

Process Table

Step	Action	terraform.workspace Value	Resulting Bucket Name
1	Start Terraform apply in workspace 'default'	default	myapp-default-bucket
2	Apply configuration with interpolated bucket name	default	myapp-default-bucket
3	Switch workspace to 'dev'	dev	myapp-dev-bucket
4	Apply configuration with interpolated bucket name	dev	myapp-dev-bucket
5	Switch workspace to 'prod'	prod	myapp-prod-bucket
6	Apply configuration with interpolated bucket name	prod	myapp-prod-bucket
7	End - workspace interpolation done for each workspace

💡 Terraform finishes applying configuration using the current workspace name for interpolation.

Status Tracker

Variable	Start	After Step 3	After Step 5	Final
terraform.workspace	default	dev	prod	prod
bucket name	myapp-default-bucket	myapp-dev-bucket	myapp-prod-bucket	myapp-prod-bucket

Key Moments - 2 Insights

Why does the bucket name change when switching workspaces?

Because ${terraform.workspace} is replaced with the current workspace name at each apply step, as shown in execution_table rows 1, 3, and 5.

Is the bucket name fixed or dynamic?

It is dynamic and depends on the workspace, demonstrated by the variable_tracker showing bucket name changes after workspace switches.

Visual Quiz - 3 Questions

Look at the execution_table, what is the bucket name at Step 4?

A myapp-default-bucket

B myapp-prod-bucket

C myapp-dev-bucket

D myapp-test-bucket

💡 Hint

Check the terraform.workspace value and bucket name at Step 4 in the execution_table.

At which step does terraform.workspace first change from 'default'?

A Step 2

B Step 3

C Step 5

D Step 6

💡 Hint

Look at the terraform.workspace column in the execution_table to find when it changes from 'default'.

If you add a new workspace 'test', what would the bucket name be when applying in that workspace?

A myapp-test-bucket

B myapp-prod-bucket

C myapp-default-bucket

D myapp-dev-bucket

💡 Hint

Refer to how bucket names are formed by combining 'myapp-' with the current workspace name from variable_tracker.

Concept Snapshot

Terraform.workspace interpolation:
- Use ${terraform.workspace} to get current workspace name.
- Workspace name changes with 'terraform workspace select'.
- Interpolation updates config dynamically per workspace.
- Useful for naming resources uniquely per environment.
- Always run 'terraform workspace select' before apply.

Full Transcript

Terraform uses the special variable terraform.workspace to know which workspace is active. When you write ${terraform.workspace} in your configuration, Terraform replaces it with the current workspace name during apply. This lets you create resources with names that change depending on the workspace, like different buckets for dev, prod, or default. The execution table shows how the bucket name changes as you switch workspaces and apply the config. The variable tracker confirms terraform.workspace and bucket name values update step by step. This helps keep environments separate and organized.

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