Viewing docs for Terraform v6.0.2
published on Wednesday, May 6, 2026 by Pulumi
published on Wednesday, May 6, 2026 by Pulumi
Terraform
I want to use the Pulumi Terraform package (terraform) in my project.
## Provider details
- Package: terraform
- Version: v6.0.2
- Publisher: Pulumi
- Source: pulumi
- Repository: https://github.com/pulumi/pulumi-terraform
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pulumi/terraform/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/terraform/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/terraform/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/terraform/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for Terraform v6.0.2
published on Wednesday, May 6, 2026 by Pulumi
published on Wednesday, May 6, 2026 by Pulumi
The Terraform provider allows you to reference Terraform state from Pulumi programs.
Example
import { state as tf_state } from "@pulumi/terraform";
let outputs = tf_state.getLocalReferenceOutput({
path: "./terraform.0-12-24.tfstate",
});
export const state = outputs.outputs;
import pulumi
import pulumi_terraform as terraform
outputs = terraform.state.get_local_reference(path="./terraform.0-12-24.tfstate")
pulumi.export("state", outputs.outputs)
package main
import (
"github.com/pulumi/pulumi-terraform/sdk/v6/go/terraform/state"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
state := state.GetLocalReferenceOutput(ctx, state.GetLocalReferenceOutputArgs{
Path: pulumi.String("./terraform.0-12-24.tfstate"),
})
ctx.Export("state", state.Outputs())
return nil
})
}
using System.Collections.Generic;
using Pulumi;
using Pulumi.Terraform.State;
return await Deployment.RunAsync(() =>
{
var outputs = GetLocalReference.Invoke(new GetLocalReferenceInvokeArgs
{
Path = "./terraform.0-12-24.tfstate",
});
return new Dictionary<string, object?>
{
["state"] = outputs.Apply(x => x.Outputs),
};
});
package myproject;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.terraform.state.StateFunctions;
import com.pulumi.terraform.state.inputs.GetLocalReferenceArgs;
public class App {
public static void main(String[] args) {
Pulumi.run(ctx -> {
var output = StateFunctions.getLocalReference(GetLocalReferenceArgs.builder().path("./terraform.0-12-24.tfstate").build());
ctx.export("state", output.applyValue(x -> x.outputs()));
});
}
}
name: terraform-local-state-with-yaml
runtime: yaml
outputs:
state:
fn::invoke:
function: terraform:state:getLocalReference
arguments:
path: ./terraform.0-12-24.tfstate
return: outputs
Viewing docs for Terraform v6.0.2
published on Wednesday, May 6, 2026 by Pulumi
published on Wednesday, May 6, 2026 by Pulumi
