Go: TerraformDataSource - CDK Terrain (CDKTN)

Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent

Initializers

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

cdktn.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/open-constructs/cdk-terrain-go/cdktn"

cdktn.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/open-constructs/cdk-terrain-go/cdktn"

cdktn.TerraformDataSource_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformDataSource`

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

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

Type: 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

Type: TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: TerraformProvider

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​scopeRequired

​idRequired

​configRequired

​Methods

​ToString

​AddOverride

​pathRequired

​valueRequired

​OverrideLogicalId

​newLogicalIdRequired

​ResetOverrideLogicalId

​ToHclTerraform

​ToMetadata

​ToTerraform

​GetAnyMapAttribute

​terraformAttributeRequired

​GetBooleanAttribute

​terraformAttributeRequired

​GetBooleanMapAttribute

​terraformAttributeRequired

​GetListAttribute

​terraformAttributeRequired

​GetNumberAttribute

​terraformAttributeRequired

​GetNumberListAttribute

​terraformAttributeRequired

​GetNumberMapAttribute

​terraformAttributeRequired

​GetStringAttribute

​terraformAttributeRequired

​GetStringMapAttribute

​terraformAttributeRequired

​InterpolationForAttribute

​terraformAttributeRequired

​Static Functions

​IsConstruct

​xRequired

​IsTerraformElement

​xRequired

​IsTerraformDataSource

​xRequired

​Properties

​NodeRequired

​CdktfStackRequired

​FqnRequired

​FriendlyUniqueIdRequired

​TerraformMetaArgumentsRequired

​TerraformResourceTypeRequired

​TerraformGeneratorMetadataOptional

​CountOptional

​DependsOnOptional

​ForEachOptional

​LifecycleOptional

​ProviderOptional

Initializers

`scope`^Required

`id`^Required

`config`^Required

Methods

`ToString`

`AddOverride`

`path`^Required

`value`^Required

`OverrideLogicalId`

`newLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`GetAnyMapAttribute`

`terraformAttribute`^Required

`GetBooleanAttribute`

`terraformAttribute`^Required

`GetBooleanMapAttribute`

`terraformAttribute`^Required

`GetListAttribute`

`terraformAttribute`^Required

`GetNumberAttribute`

`terraformAttribute`^Required

`GetNumberListAttribute`

`terraformAttribute`^Required

`GetNumberMapAttribute`

`terraformAttribute`^Required

`GetStringAttribute`

`terraformAttribute`^Required

`GetStringMapAttribute`

`terraformAttribute`^Required

`InterpolationForAttribute`

`terraformAttribute`^Required

Static Functions

`IsConstruct`

`x`^Required

`IsTerraformElement`

`x`^Required

`IsTerraformDataSource`

`x`^Required

Properties

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Count`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Lifecycle`^Optional

`Provider`^Optional