Terraform
Go: Constructs
App
Represents a cdktf application.
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewApp(config AppConfig) App
config
Optional
- Type: AppConfig
configuration.
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
CrossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. |
Synth | Synthesizes all resources to the output directory. |
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsApp | No description. |
Of | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
HclOutput | *bool | No description. |
Manifest | Manifest | No description. |
Outdir | *string | The output directory into which resources will be synthesized. |
SkipBackendValidation | *bool | Whether to skip backend validation during synthesis of the app. |
SkipValidation | *bool | Whether to skip all validations during synthesis of the app. |
TargetStackId | *string | The stack which will be synthesized. |
Node
Required
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
HclOutput
Required
func HclOutput() *bool
- Type: *bool
Manifest
Required
func Manifest() Manifest
- Type: Manifest
Outdir
Required
func Outdir() *string
- Type: *string
The output directory into which resources will be synthesized.
SkipBackendValidation
Required
func SkipBackendValidation() *bool
- Type: *bool
Whether to skip backend validation during synthesis of the app.
SkipValidation
Required
func SkipValidation() *bool
- Type: *bool
Whether to skip all validations 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.
AzurermBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewAzurermBackend(scope Construct, props AzurermBackendConfig) AzurermBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | AzurermBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: AzurermBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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://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.
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewCloudBackend(scope Construct, props CloudBackendConfig) CloudBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | CloudBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: CloudBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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 ConsulBackendConfig) ConsulBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | ConsulBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: ConsulBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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 CosBackendConfig) CosBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | CosBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: CosBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
DataResource
The DataResource implements the standard resource lifecycle, but does not directly take any other actions.
You can use the DataResource resource without requiring or configuring a provider.
The DataResource resource is useful for storing values which need to follow a manage resource lifecycle, and for triggering provisioners when there is no other logical managed resource in which to place them.
It requires Terraform 1.4 or later.
It is also possible to generate these bindings by adding "terraform.io/builtin/terraform" to the "terraformProviders" key in your cdktf.json file and running "cdktf get".
https://developer.hashicorp.com/terraform/language/resources/terraform-data
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataResource(scope Construct, id *string, config DataConfig) DataResource
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | The scope in which to define this construct. |
id | *string | The scoped construct ID. |
config | DataConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
The scope in which to define this construct.
id
Required
- Type: *string
The scoped construct ID.
Must be unique amongst siblings in the same scope
config
Optional
- Type: DataConfig
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. |
AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
GetAnyMapAttribute | No description. |
GetBooleanAttribute | No description. |
GetBooleanMapAttribute | No description. |
GetListAttribute | No description. |
GetNumberAttribute | No description. |
GetNumberListAttribute | No description. |
GetNumberMapAttribute | No description. |
GetStringAttribute | No description. |
GetStringMapAttribute | No description. |
HasResourceMove | No description. |
ImportFrom | No description. |
InterpolationForAttribute | No description. |
MoveFromId | Move the resource corresponding to "id" to this resource. |
MoveTo | Moves this resource to the target resource given by moveTarget. |
MoveToId | Moves this resource to the resource corresponding to "id". |
ResetInput | No description. |
ResetTriggersReplace | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
AddMoveTarget
func AddMoveTarget(moveTarget *string)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
moveTarget
Required
- Type: *string
The string move target that will correspond to this resource.
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttribute
Required
- Type: *string
GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttribute
Required
- Type: *string
GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttribute
Required
- Type: *string
GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttribute
Required
- Type: *string
GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttribute
Required
- Type: *string
GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttribute
Required
- Type: *string
GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttribute
Required
- Type: *string
GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttribute
Required
- Type: *string
GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttribute
Required
- Type: *string
HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
id
Required
- Type: *string
provider
Optional
- Type: TerraformProvider
InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttribute
Required
- Type: *string
MoveFromId
func MoveFromId(id *string)
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
id
Required
- Type: *string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
MoveTo
func MoveTo(moveTarget *string, index interface{})
Moves this resource to the target resource given by moveTarget.
moveTarget
Required
- Type: *string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
index
Optional
- Type: interface{}
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
MoveToId
func MoveToId(id *string)
Moves this resource to the resource corresponding to "id".
id
Required
- Type: *string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
ResetInput
func ResetInput()
ResetTriggersReplace
func ResetTriggersReplace()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformResource | No description. |
GenerateConfigForImport | Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >". |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataResource_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.DataResource_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsTerraformResource
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataResource_IsTerraformResource(x interface{}) *bool
x
Required
- Type: interface{}
GenerateConfigForImport
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataResource_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource
Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >".
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
The scope in which to define this construct.
importToId
Required
- Type: *string
The construct id used in the generated config for the Data to import.
importFromId
Required
- Type: *string
The id of the existing Data that should be imported.
Refer to the {@link https://terraform.io/providers/builtin/terraform/latest/docs/resources/data#import import section} in the documentation of this resource for the id to use
provider
Optional
- Type: TerraformProvider
? Optional instance of the provider where the Data to import is found.
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
TerraformMetaArguments | *map[string]interface{} | No description. |
TerraformResourceType | *string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Connection | interface{} | No description. |
Count | interface{} | No description. |
DependsOn | _[]_string | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | *[]interface{} | No description. |
Id | *string | No description. |
Output | AnyMap | No description. |
InputInput | *map[string]interface{} | No description. |
TriggersReplaceInput | *map[string]interface{} | No description. |
Input | *map[string]interface{} | (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply. |
TriggersReplace | *map[string]interface{} | (Optional) A value which is stored in the instance state, and will force replacement when the value changes. |
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
TerraformMetaArguments
Required
func TerraformMetaArguments() *map[string]interface{}
- Type: *map[string]interface{}
TerraformResourceType
Required
func TerraformResourceType() *string
- Type: *string
TerraformGeneratorMetadata
Optional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
Connection
Optional
func Connection() interface{}
- Type: interface{}
Count
Optional
func Count() interface{}
- Type: interface{}
DependsOn
Optional
func DependsOn() *[]*string
- Type: _[]_string
ForEach
Optional
func ForEach() ITerraformIterator
- Type: ITerraformIterator
Lifecycle
Optional
func Lifecycle() TerraformResourceLifecycle
Provider
Optional
func Provider() TerraformProvider
- Type: TerraformProvider
Provisioners
Optional
func Provisioners() *[]interface{}
- Type: *[]interface{}
Id
Required
func Id() *string
- Type: *string
Output
Required
func Output() AnyMap
- Type: AnyMap
InputInput
Optional
func InputInput() *map[string]interface{}
- Type: *map[string]interface{}
TriggersReplaceInput
Optional
func TriggersReplaceInput() *map[string]interface{}
- Type: *map[string]interface{}
Input
Required
func Input() *map[string]interface{}
- Type: *map[string]interface{}
(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
https://developer.hashicorp.com/terraform/language/resources/terraform-data#input
TriggersReplace
Required
func TriggersReplace() *map[string]interface{}
- Type: *map[string]interface{}
(Optional) A value which is stored in the instance state, and will force replacement when the value changes.
https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers_replace
Constants
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteState
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteState(scope Construct, id *string, config DataTerraformRemoteStateRemoteConfig) DataTerraformRemoteState
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateRemoteConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
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
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateAzurermConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
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
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
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
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateConsulConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateConsul_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.DataTerraformRemoteStateConsul_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateCos
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateCos(scope Construct, id *string, config DataTerraformRemoteStateCosConfig) DataTerraformRemoteStateCos
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateCosConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateCos_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.DataTerraformRemoteStateCos_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateGcs
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateGcs(scope Construct, id *string, config DataTerraformRemoteStateGcsConfig) DataTerraformRemoteStateGcs
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateGcsConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateGcs_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.DataTerraformRemoteStateGcs_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateHttp
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateHttp(scope Construct, id *string, config DataTerraformRemoteStateHttpConfig) DataTerraformRemoteStateHttp
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateHttpConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateHttp_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.DataTerraformRemoteStateHttp_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateLocal
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateLocal(scope Construct, id *string, config DataTerraformRemoteStateLocalConfig) DataTerraformRemoteStateLocal
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateLocalConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateLocal_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.DataTerraformRemoteStateLocal_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateOss
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateOss(scope Construct, id *string, config DataTerraformRemoteStateOssConfig) DataTerraformRemoteStateOss
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateOssConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateOss_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.DataTerraformRemoteStateOss_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStatePg
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStatePg(scope Construct, id *string, config DataTerraformRemoteStatePgConfig) DataTerraformRemoteStatePg
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStatePgConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStatePg_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.DataTerraformRemoteStatePg_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateS3
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateS3(scope Construct, id *string, config DataTerraformRemoteStateS3Config) DataTerraformRemoteStateS3
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateS3Config | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateS3_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.DataTerraformRemoteStateS3_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
DataTerraformRemoteStateSwift
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewDataTerraformRemoteStateSwift(scope Construct, id *string, config DataTerraformRemoteStateSwiftConfig) DataTerraformRemoteStateSwift
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | DataTerraformRemoteStateSwiftConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
ToString
func ToString() *string
Returns a string representation of this construct.
AddOverride
AddOverride
func AddOverride(path *string, value interface{})
path
Required
- Type: *string
value
Required
- Type: interface{}
OverrideLogicalId
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
ResetOverrideLogicalId
func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
ToMetadata
ToMetadata
func ToMetadata() interface{}
ToTerraform
ToTerraform
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
Get
Get
func Get(output *string) IResolvable
output
Required
- Type: *string
GetBoolean
GetBoolean
func GetBoolean(output *string) IResolvable
output
Required
- Type: *string
GetList
GetList
func GetList(output *string) *[]*string
output
Required
- Type: *string
GetNumber
GetNumber
func GetNumber(output *string) *f64
output
Required
- Type: *string
GetString
GetString
func GetString(output *string) *string
output
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateSwift_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
IsTerraformElement
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.DataTerraformRemoteStateSwift_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
Node
Required
Node
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
CdktfStack
Required
CdktfStack
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func CdktfStack() TerraformStack
- Type: TerraformStack
Fqn
Required
Fqn
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func Fqn() *string
- Type: *string
FriendlyUniqueId
Required
FriendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func FriendlyUniqueId() *string
- Type: *string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
TfResourceType
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func TfResourceType() *string
- Type: *string
GcsBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewGcsBackend(scope Construct, props GcsBackendConfig) GcsBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | GcsBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: GcsBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.GcsBackend_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.GcsBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.GcsBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
HttpBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewHttpBackend(scope Construct, props HttpBackendConfig) HttpBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | HttpBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: HttpBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.HttpBackend_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.HttpBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.HttpBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
ImportableResource
Class used to represent an importable resource.
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewImportableResource(scope Construct, name *string, config IImportableConfig) ImportableResource
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
name | *string | No description. |
config | IImportableConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
config
Required
- Type: IImportableConfig
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 | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.ImportableResource_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.ImportableResource_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
LocalBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewLocalBackend(scope Construct, props LocalBackendConfig) LocalBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | LocalBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Optional
- Type: LocalBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.LocalBackend_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.LocalBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.LocalBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
OssBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewOssBackend(scope Construct, props OssBackendConfig) OssBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | OssBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: OssBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.OssBackend_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.OssBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.OssBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
PgBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewPgBackend(scope Construct, props PgBackendConfig) PgBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | PgBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: PgBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.PgBackend_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.PgBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.PgBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
RemoteBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewRemoteBackend(scope Construct, props RemoteBackendConfig) RemoteBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | RemoteBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: RemoteBackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.RemoteBackend_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.RemoteBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.RemoteBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Resource
- Implements: IResource
A construct which represents a resource.
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewResource(scope Construct, id *string) Resource
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
ToString
ToString
func ToString() *string
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsConstruct
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.Resource_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.
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
Stack | TerraformStack | The stack in which this resource is defined. |
Node
Required
Node
- Deprecated: - Please use Construct from the constructs package instead.
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
Stack
Required
Stack
- Deprecated: - Please use Construct from the constructs package instead.
func Stack() TerraformStack
- Type: TerraformStack
The stack in which this resource is defined.
S3Backend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewS3Backend(scope Construct, props S3BackendConfig) S3Backend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | S3BackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: S3BackendConfig
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
_fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.S3Backend_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.S3Backend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.S3Backend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
SwiftBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewSwiftBackend(scope Construct, props SwiftBackendConfig) SwiftBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
props | SwiftBackendConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
props
Required
- Type: SwiftBackendConfig
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
ToString
func ToString() *string
Returns a string representation of this construct.
AddOverride
AddOverride
func AddOverride(path *string, value interface{})
path
Required
- Type: *string
value
Required
- Type: interface{}
OverrideLogicalId
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
ResetOverrideLogicalId
func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
ToMetadata
func ToMetadata() interface{}
ToTerraform
ToTerraform
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.SwiftBackend_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
IsTerraformElement
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.SwiftBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.SwiftBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
Node
Required
Node
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
CdktfStack
Required
CdktfStack
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func CdktfStack() TerraformStack
- Type: TerraformStack
Fqn
Required
Fqn
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func Fqn() *string
- Type: *string
FriendlyUniqueId
Required
FriendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
func FriendlyUniqueId() *string
- Type: *string
TerraformAsset
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformAsset(scope Construct, id *string, config TerraformAssetConfig) TerraformAsset
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | TerraformAssetConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
- Type: TerraformAssetConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
ToString
func ToString() *string
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformAsset_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.
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
FileName | *string | Name of the asset. |
Path | *string | The path relative to the root of the terraform directory in posix format Use this property to reference the asset. |
AssetHash | *string | No description. |
Type | AssetType | No description. |
Node
Required
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
FileName
Required
func FileName() *string
- Type: *string
Name of the asset.
Path
Required
func Path() *string
- Type: *string
The path relative to the root of the terraform directory in posix format Use this property to reference the asset.
AssetHash
Required
func AssetHash() *string
- Type: *string
Type
Required
func Type() AssetType
- Type: AssetType
TerraformBackend
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformBackend(scope Construct, id *string, name *string) TerraformBackend
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
name | *string | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
name
Required
- Type: *string
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
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.
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.
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
name
Required
- Type: *string
fromStack
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformBackend_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.TerraformBackend_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsBackend
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformBackend_IsBackend(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
TerraformDataSource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformDataSource(scope Construct, id *string, config TerraformResourceConfig) TerraformDataSource
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | TerraformResourceConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
- Type: TerraformResourceConfig
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetAnyMapAttribute | No description. |
GetBooleanAttribute | No description. |
GetBooleanMapAttribute | No description. |
GetListAttribute | No description. |
GetNumberAttribute | No description. |
GetNumberListAttribute | No description. |
GetNumberMapAttribute | No description. |
GetStringAttribute | No description. |
GetStringMapAttribute | No description. |
InterpolationForAttribute | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttribute
Required
- Type: *string
GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttribute
Required
- Type: *string
GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttribute
Required
- Type: *string
GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttribute
Required
- Type: *string
GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttribute
Required
- Type: *string
GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttribute
Required
- Type: *string
GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttribute
Required
- Type: *string
GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttribute
Required
- Type: *string
GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttribute
Required
- Type: *string
InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttribute
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformDataSource | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformDataSource_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.TerraformDataSource_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsTerraformDataSource
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformDataSource_IsTerraformDataSource(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
TerraformMetaArguments | *map[string]interface{} | No description. |
TerraformResourceType | *string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Count | interface{} | No description. |
DependsOn | _[]_string | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
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
TerraformMetaArguments
Required
func TerraformMetaArguments() *map[string]interface{}
- Type: *map[string]interface{}
TerraformResourceType
Required
func TerraformResourceType() *string
- Type: *string
TerraformGeneratorMetadata
Optional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
Count
Optional
func Count() interface{}
- Type: interface{}
DependsOn
Optional
func DependsOn() *[]*string
- Type: _[]_string
ForEach
Optional
func ForEach() ITerraformIterator
- Type: ITerraformIterator
Lifecycle
Optional
func Lifecycle() TerraformResourceLifecycle
Provider
Optional
func Provider() TerraformProvider
- Type: TerraformProvider
TerraformElement
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformElement(scope Construct, id *string, elementType *string) TerraformElement
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
elementType | *string | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
elementType
Optional
- Type: *string
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 | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformElement_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.TerraformElement_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
TerraformHclModule
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformHclModule(scope Construct, id *string, options TerraformHclModuleConfig) TerraformHclModule
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
options | TerraformHclModuleConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
options
Required
- Type: TerraformHclModuleConfig
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 | No description. |
AddProvider | No description. |
GetString | No description. |
InterpolationForOutput | No description. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
Set | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
AddProvider
func AddProvider(provider interface{})
provider
Required
- Type: interface{}
GetString
func GetString(output *string) *string
output
Required
- Type: *string
InterpolationForOutput
func InterpolationForOutput(moduleOutput *string) IResolvable
moduleOutput
Required
- Type: *string
Get
func Get(output *string) interface{}
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
Set
func Set(variable *string, value interface{})
variable
Required
- Type: *string
value
Required
- Type: interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformHclModule_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.TerraformHclModule_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
Source | *string | No description. |
Providers | *[]interface{} | No description. |
SkipAssetCreationFromLocalModules | *bool | No description. |
Version | *string | No description. |
DependsOn | _[]_string | No description. |
ForEach | ITerraformIterator | No description. |
Variables | *map[string]interface{} | No description. |
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
Source
Required
func Source() *string
- Type: *string
Providers
Optional
func Providers() *[]interface{}
- Type: *[]interface{}
SkipAssetCreationFromLocalModules
Optional
func SkipAssetCreationFromLocalModules() *bool
- Type: *bool
Version
Optional
func Version() *string
- Type: *string
DependsOn
Optional
func DependsOn() *[]*string
- Type: _[]_string
ForEach
Optional
func ForEach() ITerraformIterator
- Type: ITerraformIterator
Variables
Optional
func Variables() *map[string]interface{}
- Type: *map[string]interface{}
TerraformLocal
- Implements: ITerraformAddressable
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformLocal(scope Construct, id *string, expression interface{}) TerraformLocal
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
expression | interface{} | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
expression
Required
- Type: interface{}
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 | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformLocal_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.TerraformLocal_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
AsAnyMap | *map[string]interface{} | No description. |
AsBoolean | IResolvable | No description. |
AsBooleanMap | _map[string]_bool | No description. |
AsList | _[]_string | No description. |
AsNumber | *f64 | No description. |
AsNumberMap | _map[string]_f64 | No description. |
AsString | *string | No description. |
AsStringMap | _map[string]_string | No description. |
Expression | interface{} | No description. |
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
AsAnyMap
Required
func AsAnyMap() *map[string]interface{}
- Type: *map[string]interface{}
AsBoolean
Required
func AsBoolean() IResolvable
- Type: IResolvable
AsBooleanMap
Required
func AsBooleanMap() *map[string]*bool
- Type: _map[string]_bool
AsList
Required
func AsList() *[]*string
- Type: _[]_string
AsNumber
Required
func AsNumber() *f64
- Type: *f64
AsNumberMap
Required
func AsNumberMap() *map[string]*f64
- Type: _map[string]_f64
AsString
Required
func AsString() *string
- Type: *string
AsStringMap
Required
func AsStringMap() *map[string]*string
- Type: _map[string]_string
Expression
Required
func Expression() interface{}
- Type: interface{}
TerraformModule
- Implements: ITerraformDependable
TerraformModule can be used to reference a local terraform module or a module from the Terraform Registry.
It should be used if you can not use generated bindings for the module as you would get by adding the module to your cdktf.json files "terraformModules" array and running cdktf get.
This class is not creating a Terraform module to be used outside of CDKTF. If you want to bundle certain resources together like you would do with a Terraform module, you should use Constructs instead, see http://cdk.tf/constructs for more details.
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformModule(scope Construct, id *string, options TerraformModuleConfig) TerraformModule
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
options | TerraformModuleConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
options
Required
- Type: TerraformModuleConfig
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 | No description. |
AddProvider | No description. |
GetString | No description. |
InterpolationForOutput | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
AddProvider
func AddProvider(provider interface{})
provider
Required
- Type: interface{}
GetString
func GetString(output *string) *string
output
Required
- Type: *string
InterpolationForOutput
func InterpolationForOutput(moduleOutput *string) IResolvable
moduleOutput
Required
- Type: *string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformModule_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.TerraformModule_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
Source | *string | No description. |
Providers | *[]interface{} | No description. |
SkipAssetCreationFromLocalModules | *bool | No description. |
Version | *string | No description. |
DependsOn | _[]_string | No description. |
ForEach | ITerraformIterator | No description. |
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
Source
Required
func Source() *string
- Type: *string
Providers
Optional
func Providers() *[]interface{}
- Type: *[]interface{}
SkipAssetCreationFromLocalModules
Optional
func SkipAssetCreationFromLocalModules() *bool
- Type: *bool
Version
Optional
func Version() *string
- Type: *string
DependsOn
Optional
func DependsOn() *[]*string
- Type: _[]_string
ForEach
Optional
func ForEach() ITerraformIterator
- Type: ITerraformIterator
TerraformOutput
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformOutput(scope Construct, id *string, config TerraformOutputConfig) TerraformOutput
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | TerraformOutputConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
- Type: TerraformOutputConfig
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 | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformOutput | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformOutput_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.TerraformOutput_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsTerraformOutput
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformOutput_IsTerraformOutput(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
StaticId | *bool | No description. |
Value | interface{} | No description. |
DependsOn | *[]ITerraformDependable | No description. |
Description | *string | No description. |
Precondition | Precondition | No description. |
Sensitive | *bool | No description. |
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
StaticId
Required
func StaticId() *bool
- Type: *bool
Value
Required
func Value() interface{}
- Type: interface{}
DependsOn
Optional
func DependsOn() *[]ITerraformDependable
- Type: *[]ITerraformDependable
Description
Optional
func Description() *string
- Type: *string
Precondition
Optional
func Precondition() Precondition
- Type: Precondition
Sensitive
Optional
func Sensitive() *bool
- Type: *bool
TerraformProvider
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformProvider(scope Construct, id *string, config TerraformProviderConfig) TerraformProvider
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | TerraformProviderConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
- Type: TerraformProviderConfig
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. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformProvider | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformProvider_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.TerraformProvider_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsTerraformProvider
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformProvider_IsTerraformProvider(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
MetaAttributes | *map[string]interface{} | No description. |
TerraformResourceType | *string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
TerraformProviderSource | *string | No description. |
Alias | *string | No description. |
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
MetaAttributes
Required
func MetaAttributes() *map[string]interface{}
- Type: *map[string]interface{}
TerraformResourceType
Required
func TerraformResourceType() *string
- Type: *string
TerraformGeneratorMetadata
Optional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
TerraformProviderSource
Optional
func TerraformProviderSource() *string
- Type: *string
Alias
Optional
func Alias() *string
- Type: *string
TerraformRemoteState
- Implements: ITerraformAddressable
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformRemoteState(scope Construct, id *string, backend *string, config DataTerraformRemoteStateConfig) TerraformRemoteState
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
backend | *string | No description. |
config | DataTerraformRemoteStateConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
backend
Required
- Type: *string
config
Required
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 | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
Adds this resource to the terraform JSON output.
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
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformRemoteState_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.TerraformRemoteState_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
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
Name | Type | Description |
---|---|---|
TfResourceType | *string | No description. |
TfResourceType
Required
func TfResourceType() *string
- Type: *string
TerraformResource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformResource(scope Construct, id *string, config TerraformResourceConfig) TerraformResource
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | TerraformResourceConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
- Type: TerraformResourceConfig
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. |
AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
GetAnyMapAttribute | No description. |
GetBooleanAttribute | No description. |
GetBooleanMapAttribute | No description. |
GetListAttribute | No description. |
GetNumberAttribute | No description. |
GetNumberListAttribute | No description. |
GetNumberMapAttribute | No description. |
GetStringAttribute | No description. |
GetStringMapAttribute | No description. |
HasResourceMove | No description. |
ImportFrom | No description. |
InterpolationForAttribute | No description. |
MoveFromId | Move the resource corresponding to "id" to this resource. |
MoveTo | Moves this resource to the target resource given by moveTarget. |
MoveToId | Moves this resource to the resource corresponding to "id". |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
AddMoveTarget
func AddMoveTarget(moveTarget *string)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
moveTarget
Required
- Type: *string
The string move target that will correspond to this resource.
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttribute
Required
- Type: *string
GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttribute
Required
- Type: *string
GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttribute
Required
- Type: *string
GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttribute
Required
- Type: *string
GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttribute
Required
- Type: *string
GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttribute
Required
- Type: *string
GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttribute
Required
- Type: *string
GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttribute
Required
- Type: *string
GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttribute
Required
- Type: *string
HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
id
Required
- Type: *string
provider
Optional
- Type: TerraformProvider
InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttribute
Required
- Type: *string
MoveFromId
func MoveFromId(id *string)
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
id
Required
- Type: *string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
MoveTo
func MoveTo(moveTarget *string, index interface{})
Moves this resource to the target resource given by moveTarget.
moveTarget
Required
- Type: *string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
index
Optional
- Type: interface{}
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
MoveToId
func MoveToId(id *string)
Moves this resource to the resource corresponding to "id".
id
Required
- Type: *string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformResource | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformResource_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.TerraformResource_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
IsTerraformResource
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformResource_IsTerraformResource(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
TerraformMetaArguments | *map[string]interface{} | No description. |
TerraformResourceType | *string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Connection | interface{} | No description. |
Count | interface{} | No description. |
DependsOn | _[]_string | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | *[]interface{} | No description. |
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
TerraformMetaArguments
Required
func TerraformMetaArguments() *map[string]interface{}
- Type: *map[string]interface{}
TerraformResourceType
Required
func TerraformResourceType() *string
- Type: *string
TerraformGeneratorMetadata
Optional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
Connection
Optional
func Connection() interface{}
- Type: interface{}
Count
Optional
func Count() interface{}
- Type: interface{}
DependsOn
Optional
func DependsOn() *[]*string
- Type: _[]_string
ForEach
Optional
func ForEach() ITerraformIterator
- Type: ITerraformIterator
Lifecycle
Optional
func Lifecycle() TerraformResourceLifecycle
Provider
Optional
func Provider() TerraformProvider
- Type: TerraformProvider
Provisioners
Optional
func Provisioners() *[]interface{}
- Type: *[]interface{}
TerraformStack
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformStack(scope Construct, id *string) TerraformStack
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddDependency | No description. |
AddOverride | No description. |
AllProviders | No description. |
DependsOn | No description. |
EnsureBackendExists | No description. |
GetLogicalId | No description. |
HasResourceMove | No description. |
PrepareStack | No description. |
RegisterIncomingCrossStackReference | No description. |
RegisterOutgoingCrossStackReference | No description. |
RunAllValidations | Run all validations on the stack. |
ToHclTerraform | No description. |
ToTerraform | No description. |
ToString
func ToString() *string
Returns a string representation of this construct.
AddDependency
func AddDependency(dependency TerraformStack)
dependency
Required
- Type: TerraformStack
AddOverride
func AddOverride(path *string, value interface{})
path
Required
- Type: *string
value
Required
- Type: interface{}
AllProviders
func AllProviders() *[]TerraformProvider
DependsOn
func DependsOn(stack TerraformStack) *bool
stack
Required
- Type: TerraformStack
EnsureBackendExists
func EnsureBackendExists() TerraformBackend
GetLogicalId
func GetLogicalId(tfElement interface{}) *string
tfElement
Required
- Type: interface{}
HasResourceMove
func HasResourceMove() *bool
PrepareStack
func PrepareStack()
RegisterIncomingCrossStackReference
func RegisterIncomingCrossStackReference(fromStack TerraformStack) TerraformRemoteState
fromStack
Required
- Type: TerraformStack
RegisterOutgoingCrossStackReference
func RegisterOutgoingCrossStackReference(identifier *string) TerraformOutput
identifier
Required
- Type: *string
RunAllValidations
func RunAllValidations()
Run all validations on the stack.
ToHclTerraform
func ToHclTerraform() *map[string]interface{}
ToTerraform
func ToTerraform() interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsStack | No description. |
Of | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformStack_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.
IsStack
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformStack_IsStack(x interface{}) *bool
x
Required
- Type: interface{}
Of
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformStack_Of(construct IConstruct) TerraformStack
construct
Required
- Type: github.com/aws/constructs-go/constructs/v10.IConstruct
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
Dependencies | *[]TerraformStack | No description. |
MoveTargets | TerraformResourceTargets | No description. |
Synthesizer | IStackSynthesizer | No description. |
Node
Required
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
Dependencies
Required
func Dependencies() *[]TerraformStack
- Type: *[]TerraformStack
MoveTargets
Required
func MoveTargets() TerraformResourceTargets
- Type: TerraformResourceTargets
Synthesizer
Required
func Synthesizer() IStackSynthesizer
- Type: IStackSynthesizer
TerraformVariable
- Implements: ITerraformAddressable
Initializers
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.NewTerraformVariable(scope Construct, id *string, config TerraformVariableConfig) TerraformVariable
Name | Type | Description |
---|---|---|
scope | github.com/aws/constructs-go/constructs/v10.Construct | No description. |
id | *string | No description. |
config | TerraformVariableConfig | No description. |
scope
Required
- Type: github.com/aws/constructs-go/constructs/v10.Construct
id
Required
- Type: *string
config
Required
- Type: TerraformVariableConfig
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 | No description. |
AddValidation | No description. |
SynthesizeAttributes | No description. |
SynthesizeHclAttributes | No description. |
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.
ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}
AddValidation
func AddValidation(validation TerraformVariableValidationConfig)
validation
Required
SynthesizeAttributes
func SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes
func SynthesizeHclAttributes() *map[string]interface{}
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
import "github.com/hashicorp/terraform-cdk-go/cdktf"
cdktf.TerraformVariable_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.TerraformVariable_IsTerraformElement(x interface{}) *bool
x
Required
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node | github.com/aws/constructs-go/constructs/v10.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | *string | No description. |
FriendlyUniqueId | *string | No description. |
BooleanValue | IResolvable | No description. |
ListValue | _[]_string | No description. |
NumberValue | *f64 | No description. |
StringValue | *string | No description. |
Value | interface{} | No description. |
Default | interface{} | No description. |
Description | *string | No description. |
Nullable | *bool | No description. |
Sensitive | *bool | No description. |
Type | *string | No description. |
Validation | *[]TerraformVariableValidationConfig | No description. |
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
BooleanValue
Required
func BooleanValue() IResolvable
- Type: IResolvable
ListValue
Required
func ListValue() *[]*string
- Type: _[]_string
NumberValue
Required
func NumberValue() *f64
- Type: *f64
StringValue
Required
func StringValue() *string
- Type: *string
Value
Required
func Value() interface{}
- Type: interface{}
Default
Optional
func Default() interface{}
- Type: interface{}
Description
Optional
func Description() *string
- Type: *string
Nullable
Optional
func Nullable() *bool
- Type: *bool
Sensitive
Optional
func Sensitive() *bool
- Type: *bool
Type
Optional
func Type() *string
- Type: *string
Validation
Optional
func Validation() *[]TerraformVariableValidationConfig
- Type: *[]TerraformVariableValidationConfig