Documentation Index
Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
Use this file to discover all available pages before exploring further.
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.
Initializers
using Io.Cdktn;
new CloudBackend(Construct Scope, CloudBackendConfig Props);
| Name | Type | Description |
|---|
Scope | Constructs.Construct | No description. |
Props | CloudBackendConfig | No description. |
ScopeRequired
- Type: Constructs.Construct
PropsRequired
Methods
| Name | Description |
|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
AddOverride
private void AddOverride(string Path, object Value)
PathRequired
ValueRequired
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
NewLogicalIdRequired
The new logical ID to use for this stack element.
ResetOverrideLogicalId
private void ResetOverrideLogicalId()
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
ScopeRequired
- Type: Constructs.Construct
NameRequired
FromStackRequired
Static Functions
| Name | Description |
|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using Io.Cdktn;
CloudBackend.IsConstruct(object X);
x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
XRequired
Any object.
using Io.Cdktn;
CloudBackend.IsTerraformElement(object X);
XRequired
IsBackend
using Io.Cdktn;
CloudBackend.IsBackend(object X);
XRequired
Properties
| Name | Type | Description |
|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
NodeRequired
public Node Node { get; }
CdktfStackRequired
public TerraformStack CdktfStack { get; }
FqnRequired
public string Fqn { get; }
FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
