Package com.hashicorp.cdktf

Class CloudBackend

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

com.hashicorp.cdktf.TerraformElement

com.hashicorp.cdktf.TerraformBackend

com.hashicorp.cdktf.CloudBackend

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-15T15:38:00.844Z")
@Stability(Experimental)
public class CloudBackend
extends TerraformBackend

(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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CloudBackend.Builder	(experimental) A fluent builder for CloudBackend.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CloudBackend(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudBackend(software.amazon.jsii.JsiiObjectRef objRef)
	CloudBackend(software.constructs.Construct scope, CloudBackendConfig props)

Method Summary

Modifier and Type	Method	Description
TerraformRemoteState	getRemoteStateDataSource(software.constructs.Construct scope, String name, String _fromStack)	(experimental) Creates a TerraformRemoteState resource that accesses this backend.
protected Map<String,Object>	synthesizeAttributes()
protected Map<String,Object>	synthesizeHclAttributes()
Object	toHclTerraform()
Object	toMetadata()
Object	toTerraform()	(experimental) Adds this resource to the terraform JSON output.

Methods inherited from class com.hashicorp.cdktf.TerraformBackend

getName, isBackend

Methods inherited from class com.hashicorp.cdktf.TerraformElement

addOverride, getCdktfStack, getConstructNodeMetadata, getFqn, getFriendlyUniqueId, getRawOverrides, isTerraformElement, overrideLogicalId, resetOverrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

CloudBackend

protected CloudBackend(software.amazon.jsii.JsiiObjectRef objRef)

CloudBackend

protected CloudBackend(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CloudBackend

@Stability(Experimental)
public CloudBackend(@NotNull
 software.constructs.Construct scope,
 @NotNull
 CloudBackendConfig props)

Parameters:

scope - This parameter is required.

props - This parameter is required.

Method Details

getRemoteStateDataSource

@Stability(Experimental)
@NotNull
public TerraformRemoteState getRemoteStateDataSource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String name,
 @NotNull
 String _fromStack)

(experimental) Creates a TerraformRemoteState resource that accesses this backend.

Specified by:

getRemoteStateDataSource in class TerraformBackend

Parameters:

scope - This parameter is required.

name - This parameter is required.

_fromStack - This parameter is required.

synthesizeAttributes

@Stability(Experimental)
@NotNull
protected Map<String,Object> synthesizeAttributes()

Overrides:

synthesizeAttributes in class TerraformBackend

synthesizeHclAttributes

@Stability(Experimental)
@NotNull
protected Map<String,Object> synthesizeHclAttributes()

Overrides:

synthesizeHclAttributes in class TerraformBackend

toHclTerraform

@Stability(Experimental)
@NotNull
public Object toHclTerraform()

Overrides:

toHclTerraform in class TerraformBackend

toMetadata

@Stability(Experimental)
@NotNull
public Object toMetadata()

Overrides:

toMetadata in class TerraformBackend

toTerraform

@Stability(Experimental)
@NotNull
public Object toTerraform()

(experimental) Adds this resource to the terraform JSON output.

Overrides:

toTerraform in class TerraformBackend