Terraform validate for syntax check - Mini Project: Build & Apply

Terraform validate for syntax check

📖 Scenario: You are setting up a simple Terraform configuration to create an AWS S3 bucket. Before applying the configuration, you want to ensure the syntax is correct using Terraform's validation command.

🎯 Goal: Create a basic Terraform configuration for an AWS S3 bucket and use terraform validate to check the syntax before deployment.

📋 What You'll Learn

Create a Terraform configuration file named main.tf with an AWS provider and an S3 bucket resource

Add a variable for the bucket name

Use terraform validate to check the syntax of the configuration

💡 Why This Matters

🌍 Real World

Terraform validate is used by cloud engineers to catch syntax errors early before deploying infrastructure, saving time and avoiding mistakes.

💼 Career

Knowing how to write Terraform configurations and validate them is essential for roles like Cloud Engineer, DevOps Engineer, and Infrastructure Engineer.

1

Create the initial Terraform configuration

Create a file named main.tf and write the Terraform block to specify the required Terraform version as >= 1.0.0 and the AWS provider with version ~> 4.0.

Terraform

# Your code here

Need a hint?

Start by defining the terraform block with required version and provider details. Then add the provider "aws" block with a region.

2

Add a variable for the S3 bucket name

Add a variable block named bucket_name with type string and a default value of "my-terraform-bucket".

Terraform

terraform {
  required_version = ">= 1.0.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
}

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

# Your code here

Need a hint?

Use a variable block with the name bucket_name. Set the type to string and provide the default value.

3

Add the S3 bucket resource using the variable

Add a resource block named aws_s3_bucket with the resource name my_bucket. Set the bucket attribute to use the variable bucket_name.

Terraform

terraform {
  required_version = ">= 1.0.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
}

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

variable "bucket_name" {
  type    = string
  default = "my-terraform-bucket"
}

# Your code here

Need a hint?

Use a resource block with type aws_s3_bucket and name my_bucket. Reference the variable with var.bucket_name.

4

Add terraform validate command comment

Add a comment line at the end of the file with the exact text # Run terraform validate to check syntax.

Terraform

terraform {
  required_version = ">= 1.0.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
}

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

variable "bucket_name" {
  type    = string
  default = "my-terraform-bucket"
}

resource "aws_s3_bucket" "my_bucket" {
  bucket = var.bucket_name
}

# Your code here

Need a hint?

Add a comment reminding to run terraform validate to check the syntax of this configuration.