Package com.hashicorp.cdktf

Class CloudBackend.Builder

java.lang.Object
com.hashicorp.cdktf.CloudBackend.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CloudBackend>
Enclosing class:
CloudBackend
@Stability(Experimental) public static final class CloudBackend.Builder extends Object implements software.amazon.jsii.Builder<CloudBackend>
(experimental) A fluent builder for CloudBackend.

  • Method Details

    • create

      @Stability(Experimental) public static CloudBackend.Builder create(software.constructs.Construct scope)
      Parameters:
      scope - This parameter is required.
      Returns:
      a new instance of CloudBackend.Builder.

    • organization

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

      Parameters:
      organization - The name of the organization containing the workspace(s) the current configuration should use. This parameter is required.
      Returns:
      this

    • workspaces

      @Stability(Experimental) public CloudBackend.Builder workspaces(NamedCloudWorkspace workspaces)
      (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:

      Parameters:
      workspaces - A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. This parameter is required.
      Returns:
      this

    • workspaces

      @Stability(Experimental) public CloudBackend.Builder workspaces(TaggedCloudWorkspaces workspaces)
      (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:

      Parameters:
      workspaces - A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. This parameter is required.
      Returns:
      this

    • hostname

      @Stability(Experimental) public CloudBackend.Builder hostname(String hostname)
      (experimental) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.

      Default: app.terraform.io

      Parameters:
      hostname - The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. This parameter is required.
      Returns:
      this

    • token

      @Stability(Experimental) public CloudBackend.Builder token(String token)
      (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.

      Parameters:
      token - The token used to authenticate with Terraform Cloud. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public CloudBackend build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CloudBackend>
      Returns:
      a newly built instance of CloudBackend.