Struct RefreshCommand 

pub struct RefreshCommand { /* private fields */ }

Command for updating Terraform state to match remote systems.

Deprecated: terraform refresh is deprecated in favor of terraform apply -refresh-only. Consider using ApplyCommand with -refresh-only instead. This command is provided for compatibility with existing workflows.

use terraform_wrapper::{Terraform, TerraformCommand};
use terraform_wrapper::commands::refresh::RefreshCommand;

let tf = Terraform::builder().working_dir("/tmp/infra").build()?;
RefreshCommand::new()
    .var("region", "us-west-2")
    .execute(&tf)
    .await?;

Implementations

impl RefreshCommand

pub fn new() -> Self

Create a new refresh command with default options.

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

Set a variable value (-var="name=value").

pub fn var_file(self, path: &str) -> Self

Add a variable definitions file (-var-file).

pub fn target(self, resource: &str) -> Self

Target a specific resource or module (-target).

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

Enable or disable state locking (-lock).

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

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

pub fn parallelism(self, n: u32) -> Self

Limit the number of concurrent operations (-parallelism).

pub fn json(self) -> Self

Enable machine-readable JSON output (-json).

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

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

Trait Implementations

impl Clone for RefreshCommand

fn clone(&self) -> RefreshCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshCommand

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

Formats the value using the given formatter.

impl Default for RefreshCommand

fn default() -> RefreshCommand

Returns the “default value” for a type.

impl TerraformCommand for RefreshCommand

type Output = CommandOutput

The output type produced by this command.

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

Build the argument list for this command.

fn supports_input(&self) -> bool

Whether this command supports the -input=false flag.

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

Execute this command against the given Terraform client.

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

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