0
0
Terraformcloud~5 mins

JSON configuration alternative in Terraform - Commands & Configuration

Choose your learning style9 modes available
Introduction
Terraform usually uses a special language to define infrastructure, but it can also use JSON format. This helps when you want to generate configurations automatically or prefer JSON syntax.
When you want to generate Terraform configurations programmatically from other tools that output JSON.
When you prefer JSON syntax over Terraform's usual language for defining infrastructure.
When integrating Terraform with systems that only accept JSON input.
When you want to validate your infrastructure code with JSON tools.
When you need to share configurations with teams familiar with JSON.
Config File - main.tf.json
main.tf.json
{
  "resource": {
    "aws_s3_bucket": {
      "example_bucket": {
        "bucket": "my-example-bucket",
        "acl": "private"
      }
    }
  }
}

This JSON file defines a Terraform configuration that creates an AWS S3 bucket named my-example-bucket with private access.

The resource key holds the resources to create. Inside it, aws_s3_bucket specifies the type, and example_bucket is the resource name. The properties like bucket and acl set the bucket name and access control.

Commands
This command initializes the Terraform working directory, downloads necessary plugins, and prepares Terraform to run.
Terminal
terraform init
Expected OutputExpected
Initializing the backend... Initializing provider plugins... - Finding latest version of hashicorp/aws... - Installing hashicorp/aws v4.0.0... - Installed hashicorp/aws v4.0.0 (signed by HashiCorp) Terraform has been successfully initialized!
This command shows what Terraform will do based on the JSON configuration, without making any changes yet.
Terminal
terraform plan
Expected OutputExpected
Terraform used the selected providers to generate an execution plan. Plan: 1 to add, 0 to change, 0 to destroy. ───────────────────────────────────────────────────────────────────────────── Note: You didn't specify an "-out" parameter to save this plan, so Terraform can't guarantee to take exactly these actions if you run "terraform apply" later.
This command applies the configuration, creating the S3 bucket as defined in the JSON file. The flag skips the confirmation prompt.
Terminal
terraform apply -auto-approve
Expected OutputExpected
aws_s3_bucket.example_bucket: Creating... aws_s3_bucket.example_bucket: Creation complete after 2s [id=my-example-bucket] Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
-auto-approve - Automatically approve the apply step without asking for confirmation
This command removes the created resources, cleaning up the infrastructure. The flag skips the confirmation prompt.
Terminal
terraform destroy -auto-approve
Expected OutputExpected
aws_s3_bucket.example_bucket: Destroying... aws_s3_bucket.example_bucket: Destruction complete after 1s Destroy complete! Resources: 1 destroyed.
-auto-approve - Automatically approve the destroy step without asking for confirmation
Key Concept

Terraform configurations can be written in JSON format as an alternative to the usual language, enabling automation and integration with JSON-based tools.

Common Mistakes
Using invalid JSON syntax like missing commas or quotes.
Terraform will fail to parse the configuration and show errors.
Always validate your JSON syntax with a JSON validator before running Terraform.
Naming the file with .tf extension instead of .tf.json for JSON configs.
Terraform expects JSON configs to have .tf.json extension to parse them correctly.
Save JSON Terraform configs with the .tf.json extension.
Mixing JSON and HCL syntax in the same file.
Terraform cannot parse mixed syntax in one file, causing errors.
Use either JSON or HCL syntax per file, not both.
Summary
Terraform supports JSON format for configuration files as an alternative to its usual language.
Use .tf.json extension for JSON configuration files so Terraform recognizes them.
Run terraform init, plan, apply, and destroy commands to manage infrastructure defined in JSON.