Terraform Output

The terraform output command is used to extract the value of an output variable from the state file.

Usage: terraform output [options] [NAME]

With no additional arguments, output will display all the outputs for the root module. If an output NAME is specified, only the value of that output is printed.

The command-line flags are all optional. The list of available flags are:

-json - If specified, the outputs are formatted as a JSON object, with a key per output. If NAME is specified, only the output specified will be returned. This can be piped into tools such as jq for further processing.
-state=path - Path to the state file. Defaults to terraform.tfstate. Ignored when remote state is used.
-module=module_name - The module path which has needed output. By default this is the root path. Other modules can be specified by a period-separated list. Example: "foo" would reference the module "foo" but "foo.bar" would reference the "bar" module in the "foo" module.

Example

let's create a file with tf extension with below content.

provider "github" {
  token = "XXXXXXXXXXXXXXXXXXX"
}
resource "github_repository" "terraform-first-repo" {
  name        = "first-repo-from-terraform"
  description = "My First resource for my youtube viewers."
  visibility  = "public"
  auto_init   = true
}
output "terraform-repo-url" {
  value = github_repository.terraform-first-repo.html_url
}

now run terraform init, terraform apply after that let's try with terraform output.

┌──(gaurav㉿learning-ocean)-[~/terraform/youtube-course/terraform-first-resource]
└─$ terraform output terraform-repo-url
"https://github.com/crgaurav/first-repo-from-terraform"

Demo Video

Previous Next