com.hashicorp.cdktf

Interface CloudBackendProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudBackendProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-23T16:54:14.404Z")
 @Stability(value=Experimental)
public interface CloudBackendProps
extends software.amazon.jsii.JsiiSerializable

(experimental) The Cloud Backend synthesizes a cloud block. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

https://www.terraform.io/cli/cloud/settings#arguments

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CloudBackendProps.Builder	builder()
default String	getHostname() (experimental) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.
String	getOrganization() (experimental) The name of the organization containing the workspace(s) the current configuration should use.
default String	getToken() (experimental) The token used to authenticate with Terraform Cloud.
Object	getWorkspaces() (experimental) A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOrganization

@Stability(value=Experimental)
 @NotNull
String getOrganization()

(experimental) The name of the organization containing the workspace(s) the current configuration should use.

getWorkspaces

@Stability(value=Experimental)
 @NotNull
Object getWorkspaces()

(experimental) A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.

The workspaces block must contain exactly one of the following arguments, each denoting a strategy for how workspaces should be mapped:

getHostname

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

(experimental) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.

Default: app.terraform.io

getToken

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

(experimental) The token used to authenticate with Terraform Cloud.

We recommend omitting the token from the configuration, and instead using terraform login or manually configuring credentials in the CLI config file.

builder

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

Returns:

a CloudBackendProps.Builder of CloudBackendProps