Terraform Modules and Providers Cheat Sheet

terraform get -update

# Download and update remote module sources.

terraform init -from-module=git::https://github.com/acme/networking.git

# Copy a module into an empty working directory and initialize it.

module "vpc" {
  source  = "terraform-aws-modules/vpc/aws"
  version = "~> 5.0"
}

# Use a Terraform Registry module with a version constraint.

module "networking" {
  source = "git::https://github.com/acme/networking.git?ref=v1.2.3"
}

# Use a module source from Git with a specific ref.

terraform providers lock -platform=darwin_amd64 -platform=linux_amd64

# Update the dependency lock file with checksums for target platforms.

terraform providers mirror ./terraform-providers

# Download required providers into a local mirror directory.

terraform {
  required_version = ">= 1.6.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 5.0"
    }
  }
}

# Pin Terraform version and provider source/version constraints.

provider_installation {
  filesystem_mirror {
    path    = "/usr/share/terraform/providers"
    include = ["registry.terraform.io/hashicorp/*"]
  }
  direct {}
}

# Configure provider installation behavior in CLI config file.

output "vpc_id" {
  description = "Created VPC ID"
  value       = aws_vpc.this.id
}

# Example of documenting reusable module outputs clearly.

variable "name" {
  type        = string
  description = "Resource name prefix"
}

# Example of typed input variables for reusable modules.

moved {
  from = aws_instance.old
  to   = aws_instance.web
}

# Use moved blocks to preserve state during resource renames in configuration.

removed {
  from = aws_instance.legacy
}

# Document intentional removal of resource addresses when refactoring.