API Reference for Go

Constructs

App

Represents a cdktf application.

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewApp(options AppOptions) App

options^Optional

• Type: AppOptions

configuration options.

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

CrossStackReference

func CrossStackReference(fromStack TerraformStack, toStack TerraformStack, identifier *string) *string

Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

fromStack^Required

• Type: TerraformStack

toStack^Required

• Type: TerraformStack

identifier^Required

• Type: *string

Synth

func Synth()

Synthesizes all resources to the output directory.

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.App_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.

x^Required

• Type: interface{}

Any object.

IsApp

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.App_IsApp(x interface{}) *bool

x^Required

• Type: interface{}

Of

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.App_Of(construct IConstruct) App

construct^Required

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

Properties

Node^Required

func Node() Node

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

The tree node.

Manifest^Required

func Manifest() Manifest

• Type: Manifest

Outdir^Required

func Outdir() *string

• Type: *string

The output directory into which resources will be synthesized.

SkipValidation^Optional

func SkipValidation() *bool

• Type: *bool

Whether to skip the validation during synthesis of the app.

TargetStackId^Optional

func TargetStackId() *string

• Type: *string

The stack which will be synthesized.

If not set, all stacks will be synthesized.

ArtifactoryBackend

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewArtifactoryBackend(scope Construct, props ArtifactoryBackendProps) ArtifactoryBackend

scope^Required

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

props^Required

• Type: ArtifactoryBackendProps

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

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.

scope^Required

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

name^Required

• Type: *string

_fromStack^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.ArtifactoryBackend_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.ArtifactoryBackend_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

IsBackend

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.ArtifactoryBackend_IsBackend(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

AzurermBackend

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewAzurermBackend(scope Construct, props AzurermBackendProps) AzurermBackend

scope^Required

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

props^Required

• Type: AzurermBackendProps

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

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.

scope^Required

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

name^Required

• Type: *string

_fromStack^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.AzurermBackend_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.AzurermBackend_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

IsBackend

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.AzurermBackend_IsBackend(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

CloudBackend

The Cloud Backend synthesizes a {@link https://www.terraform.io/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.

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewCloudBackend(scope Construct, props CloudBackendProps) CloudBackend

scope^Required

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

props^Required

• Type: CloudBackendProps

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

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.

scope^Required

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

name^Required

• Type: *string

_fromStack^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

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

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.CloudBackend_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

IsBackend

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.CloudBackend_IsBackend(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

ConsulBackend

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewConsulBackend(scope Construct, props ConsulBackendProps) ConsulBackend

scope^Required

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

props^Required

• Type: ConsulBackendProps

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

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.

scope^Required

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

name^Required

• Type: *string

_fromStack^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.ConsulBackend_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.ConsulBackend_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

IsBackend

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.ConsulBackend_IsBackend(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

CosBackend

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewCosBackend(scope Construct, props CosBackendProps) CosBackend

scope^Required

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

props^Required

• Type: CosBackendProps

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

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.

scope^Required

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

name^Required

• Type: *string

_fromStack^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.CosBackend_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.CosBackend_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

IsBackend

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.CosBackend_IsBackend(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

DataTerraformRemoteState

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewDataTerraformRemoteState(scope Construct, id *string, config DataTerraformRemoteStateRemoteConfig) DataTerraformRemoteState

scope^Required

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

id^Required

• Type: *string

config^Required

• Type: DataTerraformRemoteStateRemoteConfig

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

Get

func Get(output *string) IResolvable

output^Required

• Type: *string

GetBoolean

func GetBoolean(output *string) IResolvable

output^Required

• Type: *string

GetList

func GetList(output *string) *[]*string

output^Required

• Type: *string

GetNumber

func GetNumber(output *string) *f64

output^Required

• Type: *string

GetString

func GetString(output *string) *string

output^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.DataTerraformRemoteState_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.DataTerraformRemoteState_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

Constants

TfResourceType^Required

func TfResourceType() *string

• Type: *string

DataTerraformRemoteStateArtifactory

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewDataTerraformRemoteStateArtifactory(scope Construct, id *string, config DataTerraformRemoteStateArtifactoryConfig) DataTerraformRemoteStateArtifactory

scope^Required

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

id^Required

• Type: *string

config^Required

• Type: DataTerraformRemoteStateArtifactoryConfig

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

Get

func Get(output *string) IResolvable

output^Required

• Type: *string

GetBoolean

func GetBoolean(output *string) IResolvable

output^Required

• Type: *string

GetList

func GetList(output *string) *[]*string

output^Required

• Type: *string

GetNumber

func GetNumber(output *string) *f64

output^Required

• Type: *string

GetString

func GetString(output *string) *string

output^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.DataTerraformRemoteStateArtifactory_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.DataTerraformRemoteStateArtifactory_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

Constants

TfResourceType^Required

func TfResourceType() *string

• Type: *string

DataTerraformRemoteStateAzurerm

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewDataTerraformRemoteStateAzurerm(scope Construct, id *string, config DataTerraformRemoteStateAzurermConfig) DataTerraformRemoteStateAzurerm

scope^Required

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

id^Required

• Type: *string

config^Required

• Type: DataTerraformRemoteStateAzurermConfig

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

Get

func Get(output *string) IResolvable

output^Required

• Type: *string

GetBoolean

func GetBoolean(output *string) IResolvable

output^Required

• Type: *string

GetList

func GetList(output *string) *[]*string

output^Required

• Type: *string

GetNumber

func GetNumber(output *string) *f64

output^Required

• Type: *string

GetString

func GetString(output *string) *string

output^Required

• Type: *string

Static Functions

IsConstruct

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.DataTerraformRemoteStateAzurerm_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.

x^Required

• Type: interface{}

Any object.

IsTerraformElement

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.DataTerraformRemoteStateAzurerm_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

Properties

Node^Required

func Node() Node

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

The tree node.

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: TerraformStack

Fqn^Required

func Fqn() *string

• Type: *string

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

Constants

TfResourceType^Required

func TfResourceType() *string

• Type: *string

DataTerraformRemoteStateConsul

Initializers

import "github.com/hashicorp/terraform-cdk-go/cdktf"

cdktf.NewDataTerraformRemoteStateConsul(scope Construct, id *string, config DataTerraformRemoteStateConsulConfig) DataTerraformRemoteStateConsul

scope^Required

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

id^Required

• Type: *string

config^Required

• Type: DataTerraformRemoteStateConsulConfig

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

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

path^Required

• Type: *string

value^Required

• Type: interface{}

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

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

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

Get

func Get(output *string) IResolvable

output^Required

• Type: *string

GetBoolean

func GetBoolean(output *string) IResolvable

output^Required

• Type: *string

GetList