Terraform.workspace interpolation - Commands & Configuration

Introduction

When managing infrastructure with Terraform, you often want to separate resources for different environments like development and production. Terraform workspaces let you do this easily by keeping different states. Using workspace interpolation helps you write flexible configurations that change based on the current workspace.

When you want to deploy the same infrastructure to multiple environments like dev, test, and prod without duplicating code.

When you need to name resources differently depending on the environment to avoid conflicts.

When you want to store environment-specific values inside your Terraform configuration automatically.

When you want to switch between environments quickly using Terraform workspaces.

When you want to keep infrastructure states isolated but use one codebase.

Config File - main.tf

main.tf

terraform {
  required_version = ">= 1.0"
}

provider "aws" {
  region = "us-east-1"
}

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

output "bucket_name" {
  value = aws_s3_bucket.example.bucket
}

This Terraform configuration creates an AWS S3 bucket. The bucket name uses ${terraform.workspace} to include the current workspace name, so each workspace creates a uniquely named bucket. The output shows the bucket name after deployment.

Commands

Create a new workspace named 'dev' to isolate resources for the development environment.

Terminal

terraform workspace new dev

Expected Output

Created and switched to workspace "dev".



You're now on a new workspace "dev".

Apply the Terraform configuration in the current workspace, creating resources with names including 'dev'.

Terminal

terraform apply -auto-approve

Expected Output

aws_s3_bucket.example: Creating...

aws_s3_bucket.example: Creation complete after 2s [id=my-app-dev-bucket]



Apply complete! Resources: 1 added, 0 changed, 0 destroyed.



Outputs:



bucket_name = "my-app-dev-bucket"

→

-auto-approve - Skip interactive approval to apply changes immediately

Switch back to the default workspace to manage resources for the default environment.

Terminal

terraform workspace select default

Expected Output

Switched to workspace "default".

Apply the configuration in the default workspace, creating resources with names including 'default'.

Terminal

terraform apply -auto-approve

Expected Output

aws_s3_bucket.example: Creating...

aws_s3_bucket.example: Creation complete after 2s [id=my-app-default-bucket]



Apply complete! Resources: 1 added, 0 changed, 0 destroyed.



Outputs:



bucket_name = "my-app-default-bucket"

→

-auto-approve - Skip interactive approval to apply changes immediately

Key Concept

If you remember nothing else from this pattern, remember: terraform.workspace lets you customize resource names and settings automatically based on the current workspace.

Common Mistakes

Using the same resource names without workspace interpolation.

This causes conflicts because Terraform tries to create resources with identical names in different workspaces.

Include ${terraform.workspace} in resource names to keep them unique per workspace.

Not creating or switching to a workspace before applying changes.

Terraform applies changes to the current workspace, which may not be the intended environment.

Always create and select the correct workspace using 'terraform workspace new' or 'terraform workspace select' before applying.

Summary

Create or select a Terraform workspace to isolate environment states.

Use ${terraform.workspace} in resource names to make them unique per workspace.

Apply Terraform changes in each workspace to deploy environment-specific resources.

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