com.hashicorp.cdktf

Interface LocalBackendProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DataTerraformRemoteStateLocalConfig

All Known Implementing Classes:

DataTerraformRemoteStateLocalConfig.Jsii$Proxy, LocalBackendProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.65.0 (build 7a02b7f)",
           date="2022-09-23T15:45:34.034Z")
 @Stability(value=Experimental)
public interface LocalBackendProps
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://www.terraform.io/language/settings/backends/local

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LocalBackendProps.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 Detail

getPath

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

(experimental) Path where the state file is stored.

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

getWorkspaceDir

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

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

builder

@Stability(value=Experimental)
static LocalBackendProps.Builder builder()

Returns:

a LocalBackendProps.Builder of LocalBackendProps