Resource documentation reference in Terraform - Mini Project: Build & Apply

Terraform Resource Documentation Reference

📖 Scenario: You are working on a Terraform project to manage cloud infrastructure. To write correct Terraform code, you need to refer to the official resource documentation for the cloud provider.In this project, you will practice how to create a Terraform configuration that references resource documentation correctly by defining a simple resource with exact attributes.

🎯 Goal: Create a Terraform configuration that defines an AWS S3 bucket resource using exact attribute names and values as specified in the official AWS S3 bucket resource documentation.

📋 What You'll Learn

Create a Terraform configuration file named main.tf.

Define an AWS S3 bucket resource with the exact name my_bucket.

Set the bucket name to my-unique-bucket-12345.

Enable versioning on the bucket using the correct nested block as per documentation.

Use the official Terraform AWS provider resource attribute names exactly.

💡 Why This Matters

🌍 Real World

Terraform is widely used to manage cloud infrastructure. Knowing how to read and apply resource documentation ensures you write correct and effective infrastructure code.

💼 Career

Cloud engineers and DevOps professionals must reference official Terraform documentation to configure resources properly and avoid errors in infrastructure deployments.

1

Create the Terraform provider block

Create a Terraform provider block for AWS with the region set to us-east-1. Use the exact block name provider "aws" and set region = "us-east-1" inside it.

Terraform

# Create the AWS provider block with region us-east-1
# Your code here

Hint

Refer to the Terraform AWS provider documentation for the syntax of the provider block.

2

Define the AWS S3 bucket resource

Add a resource block for an AWS S3 bucket with the exact resource type aws_s3_bucket and the resource name my_bucket. Set the bucket name attribute bucket to "my-unique-bucket-12345".

Terraform

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

# Define the aws_s3_bucket resource named my_bucket with bucket name
# Your code here

Hint

Check the AWS S3 bucket resource documentation for the exact attribute name to set the bucket name.

3

Enable versioning on the S3 bucket

Inside the aws_s3_bucket resource block named my_bucket, add a nested block named versioning. Inside it, set the attribute enabled to true to enable versioning on the bucket.

Terraform

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

resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-12345"
  # Add versioning block here
  # Your code here
}

Hint

Refer to the AWS S3 bucket resource documentation for how to enable versioning using the versioning nested block.

4

Add a tag to the S3 bucket

Inside the aws_s3_bucket resource block named my_bucket, add a tags attribute. Set it to a map with a single key-value pair: Environment = "Dev".

Terraform

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

resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-12345"

  versioning {
    enabled = true
  }

  # Add tags attribute here
  # Your code here
}

Hint

Check the resource documentation for the correct syntax to add tags as a map attribute.

Practice

1. What is the main purpose of Terraform resource documentation?

easy

A. To explain how to install Terraform on your computer

B. To provide pricing details for cloud services

C. To list all cloud providers available

D. To show how to configure cloud resources correctly

Solution

1. Step 1: Understand the role of resource documentation

   Resource documentation explains how to write code to create and manage cloud resources safely and correctly.

2. Step 2: Identify the correct purpose among options

   Only To show how to configure cloud resources correctly matches this purpose; others talk about pricing, providers, or installation, which are not the main focus.

3. Final Answer:

   To show how to configure cloud resources correctly -> Option D

4. Quick Check:

   Resource documentation = configuration guide [OK]

Hint: Docs explain resource setup, not pricing or installation [OK]

Common Mistakes:

• Confusing documentation with pricing info
• Thinking docs list all providers
• Assuming docs explain Terraform installation

2. Which of the following is the correct way to reference the official Terraform documentation for an AWS S3 bucket resource?

easy

A. https://aws.amazon.com/s3/docs/terraform

B. https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket

C. https://terraform.io/docs/aws/s3bucket

D. https://docs.aws.amazon.com/terraform/s3_bucket

Solution

1. Step 1: Identify the official Terraform docs URL pattern

   Terraform official docs use registry.terraform.io with provider and resource paths.

2. Step 2: Match the correct URL format for AWS S3 bucket

   https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket matches the official pattern exactly; others are incorrect or non-existent URLs.

3. Final Answer:

   https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket -> Option B

4. Quick Check:

   Official docs URL = registry.terraform.io [OK]

Hint: Official docs always start with registry.terraform.io [OK]

Common Mistakes:

• Using AWS service docs instead of Terraform docs
• Incorrect URL paths or domains
• Mixing AWS and Terraform documentation URLs

3. Given this Terraform snippet referencing an AWS EC2 instance resource:

resource "aws_instance" "example" {
  ami           = "ami-12345678"
  instance_type = "t2.micro"
  tags = {
    Name = "ExampleInstance"
  }
}

According to the official documentation, what attribute is used to specify the instance type?

medium

A. instance_type

B. type_instance

C. ec2_type

D. instanceSize

Solution

1. Step 1: Check the resource attribute names in the snippet

   The snippet uses 'instance_type' to set the EC2 instance size.

2. Step 2: Confirm with official docs attribute naming

   Official docs confirm 'instance_type' is the correct attribute; others are invalid.

3. Final Answer:

   instance_type -> Option A

4. Quick Check:

   EC2 size attribute = instance_type [OK]

Hint: Look for exact attribute names in official docs [OK]

Common Mistakes:

• Using incorrect attribute names like 'type_instance'
• Guessing attribute names without checking docs
• Confusing AWS console terms with Terraform attributes

4. You wrote this Terraform resource for an AWS S3 bucket:

resource "aws_s3_bucket" "mybucket" {
  bucket = 12345
  acl    = "private"
}

According to the official documentation, what is the error here?

medium

A. The acl attribute is missing

B. The resource type should be aws_bucket_s3

C. The bucket name must be a string, not a number

D. The bucket attribute is optional and can be omitted

Solution

1. Step 1: Check the bucket attribute type in official docs

   The 'bucket' attribute must be a string representing the bucket name.

2. Step 2: Identify the error in the code snippet

   The code uses a number (12345) instead of a string, causing a type error.

3. Final Answer:

   The bucket name must be a string, not a number -> Option C

4. Quick Check:

   Bucket name type = string [OK]

Hint: Bucket names are strings, always use quotes [OK]

Common Mistakes:

• Using numbers instead of strings for bucket names
• Wrong resource type name
• Assuming bucket attribute is optional

5. You want to create a Terraform configuration for an Azure virtual machine. The official documentation shows the resource as azurerm_linux_virtual_machine with attributes like name, resource_group_name, and size. Which of these is the best practice when writing your Terraform code?

hard

A. Always refer to the official resource documentation to use correct attribute names and required fields

B. Guess attribute names based on Azure portal labels to save time

C. Use any attribute names you prefer as Terraform will auto-correct them

D. Skip reading documentation if you have used Azure before

Solution

1. Step 1: Understand the importance of official docs

   Official docs provide accurate, up-to-date attribute names and required fields for resources.

2. Step 2: Evaluate the options for best practice

   Only Always refer to the official resource documentation to use correct attribute names and required fields advises using official docs, ensuring valid and safe infrastructure code.

3. Final Answer:

   Always refer to the official resource documentation to use correct attribute names and required fields -> Option A

4. Quick Check:

   Use official docs = best practice [OK]

Hint: Always check official docs before coding resources [OK]

Common Mistakes:

• Guessing attribute names without docs
• Assuming Terraform auto-corrects mistakes
• Skipping docs due to prior experience