Struct StateCommand 

pub struct StateCommand { /* private fields */ }

Command for managing Terraform state.

use terraform_wrapper::{Terraform, TerraformCommand};
use terraform_wrapper::commands::state::StateCommand;

let tf = Terraform::builder().working_dir("/tmp/infra").build()?;

// List resources in state
let output = StateCommand::list().execute(&tf).await?;

// Show a specific resource
let output = StateCommand::show("null_resource.example")
    .execute(&tf)
    .await?;

Implementations

impl StateCommand

pub fn list() -> Self

List resources in the state.

pub fn show(address: &str) -> Self

Show a single resource in the state.

pub fn mv(source: &str, destination: &str) -> Self

Move a resource to a different address.

pub fn rm(addresses: Vec<String>) -> Self

Remove resources from the state (without destroying them).

pub fn pull() -> Self

Pull remote state and output to stdout.

pub fn push() -> Self

Push local state to remote backend.

pub fn replace_provider(from: &str, to: &str) -> Self

Replace a provider in the state.

Migrates resources from one provider to another without modifying the actual infrastructure.

StateCommand::replace_provider(
    "registry.terraform.io/-/aws",
    "registry.terraform.io/hashicorp/aws",
)
.auto_approve()
.execute(&tf)
.await?;

pub fn auto_approve(self) -> Self

Skip interactive approval (-auto-approve).

Applies to replace-provider subcommand only.

pub fn dry_run(self) -> Self

Preview the operation without making changes (-dry-run).

Applies to mv and rm subcommands only; ignored for other subcommands.

pub fn lock(self, enabled: bool) -> Self

Enable or disable state locking (-lock).

Applies to mv, rm, and replace-provider subcommands.

pub fn lock_timeout(self, timeout: &str) -> Self

Duration to wait for state lock (-lock-timeout).

Applies to mv, rm, and replace-provider subcommands.

pub fn arg(self, arg: impl Into<String>) -> Self

Add a raw argument (escape hatch for unsupported options).

Trait Implementations

impl Clone for StateCommand

fn clone(&self) -> StateCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateCommand

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

Formats the value using the given formatter.

impl TerraformCommand for StateCommand

type Output = CommandOutput

The output type produced by this command.

fn args(&self) -> Vec<String>

Build the argument list for this command.

async fn execute(&self, tf: &Terraform) -> Result<CommandOutput>

Execute this command against the given Terraform client.

fn supports_input(&self) -> bool

Whether this command supports the -input=false flag.

fn prepare_args(&self, tf: &Terraform) -> Vec<String>

Build the argument list with -input=false injected when appropriate.