Documentation Index
Fetch the complete documentation index at: https://tfts.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
TerraformBackend is the base class for all backend configurations.
LocalBackend
Configures a local backend.
new LocalBackend(scope: Construct, config?: LocalBackendConfig)
LocalBackendConfig
| Property | Type | Description |
|---|
path | string | Path to the state file. |
workspaceDir | string | Directory for workspaces. |
S3Backend
Configures an AWS S3 backend.
new S3Backend(scope: Construct, config: S3BackendConfig)
S3BackendConfig
| Property | Type | Description |
|---|
bucket | string | Name of the S3 bucket. |
key | string | Path to the state file in the bucket. |
region | string | AWS region. |
encrypt | boolean | Whether to enable server-side encryption. |
dynamodbTable | string | DynamoDB table for state locking. |
GcsBackend
Configures a Google Cloud Storage backend.
new GcsBackend(scope: Construct, config: GcsBackendConfig)
GcsBackendConfig
| Property | Type | Description |
|---|
bucket | string | Name of the GCS bucket. |
prefix | string | Prefix for the state file. |
RemoteBackend
Configures a Terraform Cloud/Enterprise remote backend (legacy).
new RemoteBackend(scope: Construct, config: RemoteBackendConfig)
RemoteBackendConfig
| Property | Type | Description |
|---|
hostname | string | Terraform Cloud/Enterprise hostname. |
organization | string | Organization name. |
workspaces | RemoteBackendWorkspaces | Workspace configuration. |
CloudBackend
Configures the modern Terraform Cloud backend.
new CloudBackend(scope: Construct, config: CloudBackendConfig)
CloudBackendConfig
| Property | Type | Description |
|---|
organization | string | Organization name. |
workspaces | CloudBackendWorkspaces | Workspace configuration. |
hostname | string | Terraform Cloud hostname. |
