Struct TerraformConfig 

pub struct TerraformConfig { /* private fields */ }

Builder for constructing Terraform JSON configuration.

Produces a .tf.json file that Terraform can process identically to an HCL .tf file.

Implementations

impl TerraformConfig

pub fn new() -> Self

Create a new empty configuration.

pub fn required_provider(self, name: &str, source: &str, version: &str) -> Self

Add a required provider.

let config = TerraformConfig::new()
    .required_provider("aws", "hashicorp/aws", "~> 5.0")
    .required_provider("null", "hashicorp/null", "~> 3.0");

pub fn backend(self, backend_type: &str, config: Value) -> Self

Configure a backend for remote state storage.

let config = TerraformConfig::new()
    .backend("s3", json!({
        "bucket": "my-tf-state",
        "key": "terraform.tfstate",
        "region": "us-west-2"
    }));

pub fn provider(self, name: &str, config: Value) -> Self

Configure a provider.

let config = TerraformConfig::new()
    .provider("aws", json!({ "region": "us-west-2" }));

pub fn resource(self, resource_type: &str, name: &str, config: Value) -> Self

Add a managed resource.

let config = TerraformConfig::new()
    .resource("aws_instance", "web", json!({
        "ami": "ami-0c55b159",
        "instance_type": "t3.micro"
    }));

pub fn data(self, data_type: &str, name: &str, config: Value) -> Self

Add a data source.

let config = TerraformConfig::new()
    .data("aws_ami", "latest", json!({
        "most_recent": true,
        "owners": ["amazon"]
    }));

pub fn variable(self, name: &str, config: Value) -> Self

Add a variable.

let config = TerraformConfig::new()
    .variable("region", json!({
        "type": "string",
        "default": "us-west-2",
        "description": "AWS region"
    }));

pub fn output(self, name: &str, config: Value) -> Self

Add an output.

let config = TerraformConfig::new()
    .output("instance_id", json!({
        "value": "${aws_instance.web.id}",
        "description": "The instance ID"
    }));

pub fn local(self, name: &str, value: Value) -> Self

Add a local value.

let config = TerraformConfig::new()
    .local("common_tags", json!({
        "Environment": "production",
        "ManagedBy": "terraform-wrapper"
    }));

pub fn module(self, name: &str, config: Value) -> Self

Add a module reference.

let config = TerraformConfig::new()
    .module("vpc", json!({
        "source": "terraform-aws-modules/vpc/aws",
        "version": "~> 5.0",
        "cidr": "10.0.0.0/16"
    }));

pub fn to_json(&self) -> Result<String>

Serialize to a JSON string.

pub fn to_json_pretty(&self) -> Result<String>

Serialize to a pretty-printed JSON string.

pub fn write_to(&self, path: impl AsRef<Path>) -> Result<()>

Write the configuration to a file as main.tf.json.

Creates parent directories if they don’t exist.

pub fn write_to_tempdir(&self) -> Result<TempDir>

Write the configuration to a temporary directory as main.tf.json.

Returns the TempDir which will be cleaned up when dropped. Use .path() to get the directory path for Terraform::builder().working_dir().

Trait Implementations

impl Clone for TerraformConfig

fn clone(&self) -> TerraformConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TerraformConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TerraformConfig

fn default() -> TerraformConfig

Returns the “default value” for a type.

impl Serialize for TerraformConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.