Skip to main content
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 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.NewCloudBackend(scope Construct, props CloudBackendConfig) CloudBackend
NameTypeDescription
scopegithub.com/aws/constructs-go/constructs/v10.ConstructNo description.
propsCloudBackendConfigNo description.

​
scopeRequired

  • Type: github.com/aws/constructs-go/constructs/v10.Construct

​
propsRequired

​
Methods

NameDescription
ToStringReturns a string representation of this construct.
AddOverrideNo description.
OverrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraformNo description.
ToMetadataNo description.
ToTerraformAdds this resource to the terraform JSON output.
GetRemoteStateDataSourceCreates a TerraformRemoteState resource that accesses this backend.

​
ToString 

func ToString() *string
Returns a string representation of this construct.

​
AddOverride 

func AddOverride(path *string, value interface{})

​
pathRequired

  • Type: *string

​
valueRequired

  • Type: interface{}

​
OverrideLogicalId 

func OverrideLogicalId(newLogicalId *string)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • Type: *string
The new logical ID to use for this stack element.

​
ResetOverrideLogicalId 

func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.

​
ToHclTerraform 

func ToHclTerraform() interface{}

​
ToMetadata 

func ToMetadata() interface{}

​
ToTerraform 

func ToTerraform() interface{}
Adds this resource to the terraform JSON output.

​
GetRemoteStateDataSource 

func GetRemoteStateDataSource(scope Construct, name *string, _fromStack *string) TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.

​
scopeRequired

  • Type: github.com/aws/constructs-go/constructs/v10.Construct

​
nameRequired

  • Type: *string

​
_fromStackRequired

  • Type: *string

​
Static Functions

NameDescription
IsConstructChecks if x is a construct.
IsTerraformElementNo description.
IsBackendNo description.

​
IsConstruct 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.CloudBackend_IsConstruct(x interface{}) *bool
Checks if 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

  • Type: interface{}
Any object.

​
IsTerraformElement 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.CloudBackend_IsTerraformElement(x interface{}) *bool

​
xRequired

  • Type: interface{}

​
IsBackend 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.CloudBackend_IsBackend(x interface{}) *bool

​
xRequired

  • Type: interface{}

​
Properties

NameTypeDescription
Nodegithub.com/aws/constructs-go/constructs/v10.NodeThe tree node.
CdktfStackTerraformStackNo description.
Fqn*stringNo description.
FriendlyUniqueId*stringNo description.

​
NodeRequired 

func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.

​
CdktfStackRequired 

func CdktfStack() TerraformStack

​
FqnRequired 

func Fqn() *string
  • Type: *string

​
FriendlyUniqueIdRequired 

func FriendlyUniqueId() *string
  • Type: *string