Terraform state list command - Step-by-Step Execution

Process Flow - Terraform state list command

Start: Terraform state list command

↓

Read current terraform.tfstate file

↓

Parse state file for resources

↓

Extract resource addresses

↓

Display list of resource addresses

↓

End

The command reads the current Terraform state file, extracts all resource addresses, and displays them as a list.

Execution Sample

Terraform

terraform state list

Lists all resource addresses currently tracked in the Terraform state.

Process Table

Step	Action	Input	Output
1	Run command	terraform state list	Starts reading state file
2	Read state file	terraform.tfstate	Raw state JSON data
3	Parse state	Raw JSON	Extract resource objects
4	Extract addresses	Resource objects	List of resource addresses
5	Display output	List of addresses	Printed list of resources
6	End	All resources listed	Command completes successfully

💡 All resource addresses extracted and displayed from the state file

Status Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
state_file_content	empty	raw JSON data	raw JSON data	raw JSON data	raw JSON data
parsed_state	none	none	resource objects extracted	resource objects extracted	resource objects extracted
resource_addresses	empty list	empty list	empty list	list of addresses extracted	list of addresses extracted

Key Moments - 2 Insights

Why does the command only show resource addresses and not resource details?

The command focuses on listing resource addresses as identifiers. Detailed info is in other commands like 'terraform state show'. See execution_table step 4 where only addresses are extracted.

What happens if the state file is missing or corrupted?

The command will fail to read or parse the state file, resulting in an error before listing resources. This is implied in step 2 and 3 where reading and parsing happen.

Visual Quiz - 3 Questions

Look at the execution_table, what is the output after step 4?

A Raw JSON data of the state file

B Printed list of resources

C List of resource addresses

D Resource objects extracted

💡 Hint

Refer to execution_table row with Step 4, Output column

At which step does the command display the list of resource addresses to the user?

A Step 5

B Step 4

C Step 3

D Step 6

💡 Hint

Check execution_table row with Action 'Display output'

If the terraform.tfstate file is empty, what will the resource_addresses variable contain after step 4?

A List of resource addresses

B Empty list

C Raw JSON data

D Error message

💡 Hint

See variable_tracker row for resource_addresses after Step 4

Concept Snapshot

terraform state list
- Reads current terraform.tfstate file
- Extracts all resource addresses
- Prints list of resource addresses
- Does not show resource details
- Useful to see what resources are tracked

Full Transcript

The 'terraform state list' command reads the current Terraform state file named terraform.tfstate. It parses this file to find all resources tracked by Terraform. Then it extracts the addresses of these resources, which are unique identifiers like 'aws_instance.example'. Finally, it prints this list of resource addresses to the terminal. This helps users see what resources Terraform currently manages. The command stops after displaying the list. If the state file is missing or corrupted, the command will fail during reading or parsing. This command does not show detailed resource information, only their addresses.

Practice

1. What does the terraform state list command do?

easy

A. It destroys all resources in the state.

B. It applies changes to the infrastructure.

C. It initializes the Terraform working directory.

D. It shows all resources managed by Terraform in the current state.

Solution

1. Step 1: Understand the purpose of terraform state list

   This command lists all resources that Terraform currently manages in its state file.

2. Step 2: Compare with other Terraform commands

   Other commands like apply, init, and destroy perform different actions, not listing resources.

3. Final Answer:

   It shows all resources managed by Terraform in the current state. -> Option D

4. Quick Check:

   List resources = D [OK]

Hint: Remember: 'state list' shows current managed resources [OK]

Common Mistakes:

• Confusing 'state list' with 'apply' or 'destroy'
• Thinking it initializes Terraform
• Assuming it modifies resources

2. Which of the following is the correct syntax to list all resources in the Terraform state?

easy

A. terraform list state

B. terraform state list

C. terraform show state list

D. terraform state show list

Solution

1. Step 1: Recall the correct command structure

   The correct command to list resources is terraform state list.

2. Step 2: Identify incorrect syntax

   Options B, C, and D mix command parts incorrectly and will cause errors.

3. Final Answer:

   terraform state list -> Option B

4. Quick Check:

   Correct syntax = A [OK]

Hint: Command order: terraform + state + list [OK]

Common Mistakes:

• Swapping 'state' and 'list' order
• Adding extra words like 'show'
• Using unsupported command combinations

3. Given the following Terraform state list output:
module.network.aws_vpc.main
module.network.aws_subnet.public
module.compute.aws_instance.web
What will terraform state list module.network.aws_subnet.public display?

medium

A. module.network.aws_subnet.public

B. module.compute.aws_instance.web

C. module.network.aws_vpc.main

D. No output

Solution

1. Step 1: Understand filtering by resource name

   Using terraform state list with a resource name filters the output to matching resources.

2. Step 2: Match the exact resource path

   The command matches module.network.aws_subnet.public exactly, so it will output that line.

3. Final Answer:

   module.network.aws_subnet.public -> Option A

4. Quick Check:

   Filtered list = C [OK]

Hint: Filter by full resource path to get exact match [OK]

Common Mistakes:

• Expecting all resources to show
• Confusing module paths
• Assuming no output if filter is used

4. You run terraform state list module.app.aws_instance.web but get no output, even though you expect the resource to exist. What is the most likely cause?

medium

A. Terraform state list command does not support filtering.

B. Terraform state file is empty and no resources exist.

C. The resource name or module path is incorrect or misspelled.

D. You need to run terraform apply first.

Solution

1. Step 1: Check the resource path correctness

   If no output appears, the resource path or name likely does not match any resource in the state.

2. Step 2: Understand filtering behavior

   The terraform state list command supports filtering by resource name or module path.

3. Final Answer:

   The resource name or module path is incorrect or misspelled. -> Option C

4. Quick Check:

   Incorrect path = B [OK]

Hint: Check spelling and module path carefully when filtering [OK]

Common Mistakes:

• Assuming filtering is unsupported
• Thinking state file is always empty
• Believing apply is needed to list state

5. You want to list all resources managed by Terraform inside the module database only. Which command will correctly show this filtered list?

hard

A. terraform state list module.database

B. terraform state list database

C. terraform state list module.database.*

D. terraform state list module/database

Solution

1. Step 1: Understand module path filtering

   To filter resources inside a module, use the full module path prefix like module.database.

2. Step 2: Check command syntax

   terraform state list module.database uses the correct prefix without extra characters. terraform state list module.database.* uses a wildcard which is not supported in this command.

3. Final Answer:

   terraform state list module.database -> Option A

4. Quick Check:

   Filter by module prefix = A [OK]

Hint: Use full module path prefix without wildcards to filter [OK]

Common Mistakes:

• Using wildcards which are unsupported
• Omitting 'module.' prefix
• Using partial or incorrect module names