Package com.hashicorp.cdktf

Interface LocalBackendConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DataTerraformRemoteStateLocalConfig

All Known Implementing Classes:

DataTerraformRemoteStateLocalConfig.Jsii$Proxy, LocalBackendConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-15T15:38:01.049Z")
@Stability(Experimental)
public interface LocalBackendConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally.

Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/local

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LocalBackendConfig.Builder	A builder for LocalBackendConfig
static final class	LocalBackendConfig.Jsii$Proxy	An implementation for LocalBackendConfig

Method Summary

Modifier and Type	Method	Description
static LocalBackendConfig.Builder	builder()
default String	getPath()	(experimental) Path where the state file is stored.
default String	getWorkspaceDir()	(experimental) (Optional) The path to non-default workspaces.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPath

@Stability(Experimental)
@Nullable
default String getPath()

(experimental) Path where the state file is stored.

Default: - defaults to terraform.${stackId}.tfstate

getWorkspaceDir

@Stability(Experimental)
@Nullable
default String getWorkspaceDir()

(experimental) (Optional) The path to non-default workspaces.

builder

@Stability(Experimental)
static LocalBackendConfig.Builder builder()

Returns:

a LocalBackendConfig.Builder of LocalBackendConfig