Package com.hashicorp.cdktf

Interface CloudBackendConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CloudBackendConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.79.0 (build b22f628)", date="2023-07-26T11:31:27.463Z") @Stability(Experimental) public interface CloudBackendConfig extends software.amazon.jsii.JsiiSerializable
(experimental) The Cloud Backend synthesizes a
invalid @link 
{@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block
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://developer.hashicorp.com/terraform/cli/cloud/settings#arguments

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static CloudBackendConfig.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 Details

    • getOrganization

      @Stability(Experimental) @NotNull String getOrganization()
      (experimental) The name of the organization containing the workspace(s) the current configuration should use.

    • getWorkspaces

      @Stability(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(Experimental) @Nullable default String getHostname()
      (experimental) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.

      Default: app.terraform.io

    • getToken

      @Stability(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(Experimental) static CloudBackendConfig.Builder builder()
      Returns:
      a CloudBackendConfig.Builder of CloudBackendConfig