/tfstate-lookup

Lookup resource attributes in tfstate.

Primary LanguageGoMozilla Public License 2.0MPL-2.0

tfstate-lookup

Lookup resource attributes in tfstate.

Install

homebrew (mac os only)

$ brew install fujiwara/tap/tfstate-lookup

Usage (command)

Usage of tfstate-lookup:
  -s string
        tfstate file path or URL (default "terraform.tfstate")
  -state string
        tfstate file path or URL (default "terraform.tfstate")

Supported URL schemes are http(s), s3, gs, azurerm, file or remote (for Terraform Cloud and Terraform Enterprise).

$ tfstate-lookup -s .terraform/terraform.tfstate aws_vpc.main.id
vpc-1a2b3c4d

$ tfstate-lookup aws_vpc.main
{
  "arn": "arn:aws:ec2:ap-northeast-1:123456789012:vpc/vpc-1a2b3c4d",
  "assign_generated_ipv6_cidr_block": false,
  "cidr_block": "10.0.0.0/16",
  "default_network_acl_id": "acl-001234567890abcde",
  "default_route_table_id": "rtb-001234567890abcde",
  "default_security_group_id": "sg-01234567890abcdef",
  "dhcp_options_id": "dopt-64569903",
  "enable_classiclink": false,
  "enable_classiclink_dns_support": false,
  "enable_dns_hostnames": true,
  "enable_dns_support": true,
  "id": "vpc-1a2b3c4d",
  "instance_tenancy": "default",
  "ipv6_association_id": "",
  "ipv6_cidr_block": "",
  "main_route_table_id": "rtb-001234567890abcde",
  "owner_id": "123456789012",
  "tags": {
    "Name": "main"
  }
}

A remote state is supported only S3, GCS, AzureRM and Terraform Cloud / Terraform Enterprise backend currently.

Usage (Go package)

See details in godoc.

package main

import(
    "fmt"
    "os"

    "github.com/fujiwara/tfstate-lookup/tfstate"
)

func main() {
    state, _ := tfstate.ReadFile("/path/to/.terraform/terraform.tfstate")
    attrs, _ := state.Lookup("aws_vpc.main.id")
    fmt.Println(attrs.String())
}
    state, _ := tfstate.ReadURL("s3://mybucket/terraform.tfstate")
    // state, _ := tfstate.ReadURL("remote://app.terraform.io/myorg/myworkspace")
    // state, _ := tfstate.ReadURL("azurerm://{resource_group_name}/{storage_account_name}/{container_name}/{blob_name}")

LICENSE

Mozilla Public License Version 2.0