Go: Classes

Annotations

Includes API for attaching annotations such as warning messages to constructs.

Methods

Name	Description
`AddError`	Adds an { "error": < message > } metadata entry to this construct.
`AddInfo`	Adds an info metadata entry to this construct.
`AddWarning`	Adds a warning metadata entry to this construct.

`AddError`

func AddError(message *string)

Adds an { "error": < message > } metadata entry to this construct.

The toolkit will fail synthesis when errors are reported.

`message`^Required

Type: *string

The error message.

`AddInfo`

func AddInfo(message *string)

Adds an info metadata entry to this construct.

The CLI will display the info message when apps are synthesized.

`message`^Required

Type: *string

The info message.

`AddWarning`

func AddWarning(message *string)

Adds a warning metadata entry to this construct.

The CLI will display the warning when an app is synthesized. In a future release the CLI might introduce a --strict flag which will then fail the synthesis if it encounters a warning.

`message`^Required

Type: *string

The warning message.

Static Functions

Name	Description
`Of`	Returns the annotations API for a construct scope.

`Of`

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

cdktf.Annotations_Of(scope IConstruct) Annotations

Returns the annotations API for a construct scope.

`scope`^Required

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

The scope.

AnyListList

Initializers

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

cdktf.NewAnyListList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) AnyListList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`wrapsSet`^Required

Type: *bool

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: *string

`ComputeFqn`

func ComputeFqn() *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) IResolvable

`index`^Required

Type: *f64

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

AnyListMap

Initializers

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

cdktf.NewAnyListMap(terraformResource IInterpolatingParent, terraformAttribute *string) AnyListMap

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

Methods

Name	Description
`ComputeFqn`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`ComputeFqn`

func ComputeFqn() *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(key *string) IResolvable

`key`^Required

Type: *string

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

AnyMap

Implements: ITerraformAddressable, IResolvable

Initializers

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

cdktf.NewAnyMap(terraformResource IInterpolatingParent, terraformAttribute *string) AnyMap

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

Methods

Name	Description
`ComputeFqn`	No description.
`Lookup`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`ComputeFqn`

func ComputeFqn() *string

`Lookup`

func Lookup(key *string) interface{}

`key`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

AnyMapList

Initializers

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

cdktf.NewAnyMapList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) AnyMapList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`wrapsSet`^Required

Type: *bool

Methods

Name	Description
`ComputeFqn`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`ComputeFqn`

func ComputeFqn() *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) AnyMap

`index`^Required

Type: *f64

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

Aspects

Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.

Methods

Name	Description
`Add`	Adds an aspect to apply this scope before synthesis.

`Add`

func Add(aspect IAspect)

Adds an aspect to apply this scope before synthesis.

`aspect`^Required

Type: IAspect

The aspect to add.

Static Functions

Name	Description
`Of`	Returns the `Aspects` object associated with a construct scope.

`Of`

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

cdktf.Aspects_Of(scope IConstruct) Aspects

Returns the Aspects object associated with a construct scope.

`scope`^Required

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

The scope for which these aspects will apply.

Properties

Name	Type	Description
`All`	`*[]IAspect`	The list of aspects which were directly applied on this scope.

`All`^Required

func All() *[]IAspect

Type: *[]IAspect

The list of aspects which were directly applied on this scope.

AssertionReturn

Class representing the contents of a return by an assertion.

Initializers

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

testingmatchers.NewAssertionReturn(message *string, pass *bool) AssertionReturn

Name	Type	Description
`message`	`*string`	- String message containing information about the result of the assertion.
`pass`	`*bool`	- Boolean pass denoting the success of the assertion.

`message`^Required

Type: *string

String message containing information about the result of the assertion.

`pass`^Required

Type: *bool

Boolean pass denoting the success of the assertion.

Properties

Name	Type	Description
`Message`	`*string`	- String message containing information about the result of the assertion.
`Pass`	`*bool`	- Boolean pass denoting the success of the assertion.

`Message`^Required

func Message() *string

Type: *string

String message containing information about the result of the assertion.

`Pass`^Required

func Pass() *bool

Type: *bool

Boolean pass denoting the success of the assertion.

BooleanList

Initializers

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

cdktf.NewBooleanList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) BooleanList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`wrapsSet`^Required

Type: *bool

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: *string

`ComputeFqn`

func ComputeFqn() *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) IResolvable

`index`^Required

Type: *f64

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

BooleanListList

Initializers

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

cdktf.NewBooleanListList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) BooleanListList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`wrapsSet`^Required

Type: *bool

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: *string

`ComputeFqn`

func ComputeFqn() *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) IResolvable

`index`^Required

Type: *f64

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

BooleanListMap

Initializers

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

cdktf.NewBooleanListMap(terraformResource IInterpolatingParent, terraformAttribute *string) BooleanListMap

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

Methods

Name	Description
`ComputeFqn`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`ComputeFqn`

func ComputeFqn() *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(key *string) IResolvable

`key`^Required

Type: *string

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

BooleanMap

Implements: ITerraformAddressable, IResolvable

Initializers

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

cdktf.NewBooleanMap(terraformResource IInterpolatingParent, terraformAttribute *string) BooleanMap

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

Methods

Name	Description
`ComputeFqn`	No description.
`Lookup`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`ComputeFqn`

func ComputeFqn() *string

`Lookup`

func Lookup(key *string) IResolvable

`key`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

BooleanMapList

Initializers

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

cdktf.NewBooleanMapList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) BooleanMapList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`wrapsSet`^Required

Type: *bool

Methods

Name	Description
`ComputeFqn`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`ComputeFqn`

func ComputeFqn() *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) BooleanMap

`index`^Required

Type: *f64

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

CloudWorkspace

A cloud workspace can either be a single named workspace, or a list of tagged workspaces.

Initializers

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

cdktf.NewCloudWorkspace() CloudWorkspace

Name	Type	Description

Methods

Name	Description
`ToTerraform`	No description.

`ToTerraform`

func ToTerraform() interface{}

ComplexComputedList

Implements: IInterpolatingParent, IResolvable, ITerraformAddressable

Initializers

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

cdktf.NewComplexComputedList(terraformResource IInterpolatingParent, terraformAttribute *string, complexComputedListIndex *string, wrapsSet *bool) ComplexComputedList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`complexComputedListIndex`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`complexComputedListIndex`^Required

Type: *string

`wrapsSet`^Optional

Type: *bool

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`ComputeFqn`

func ComputeFqn() *string

`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(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

Deprecated: Going to be replaced by Array of ComplexListItem and will be removed in the future

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

Deprecated: Going to be replaced by Array of ComplexListItem and will be removed in the future

func Fqn() *string

Type: *string

ComplexList

Implements: ITerraformAddressable, IResolvable

Initializers

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

cdktf.NewComplexList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ComplexList

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`wrapsSet`	`*bool`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`wrapsSet`^Required

Type: *bool

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`AllWithMapKey`

func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: *string

`ComputeFqn`

func ComputeFqn() *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

ComplexMap

Implements: ITerraformAddressable, IResolvable

Initializers

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

cdktf.NewComplexMap(terraformResource IInterpolatingParent, terraformAttribute *string) ComplexMap

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

Methods

Name	Description
`ComputeFqn`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`ComputeFqn`

func ComputeFqn() *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

ComplexObject

Implements: IInterpolatingParent, IResolvable, ITerraformAddressable

Initializers

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

cdktf.NewComplexObject(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIsFromSet *bool, complexObjectIndex interface{}) ComplexObject

Name	Type	Description
`terraformResource`	`IInterpolatingParent`	No description.
`terraformAttribute`	`*string`	No description.
`complexObjectIsFromSet`	`*bool`	set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
`complexObjectIndex`	`interface{}`	the index of the complex object in a list.

`terraformResource`^Required

Type: IInterpolatingParent

`terraformAttribute`^Required

Type: *string

`complexObjectIsFromSet`^Required

Type: *bool

set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.

`complexObjectIndex`^Optional

Type: interface{}

the index of the complex object in a list.

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.

`ComputeFqn`

func ComputeFqn() *string

`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(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`CreationStack`	`_[]_string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: _[]_string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

DefaultTokenResolver

Implements: ITokenResolver

Default resolver implementation.

Initializers

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

cdktf.NewDefaultTokenResolver(concat IFragmentConcatenator) DefaultTokenResolver

Name	Type	Description
`concat`	`IFragmentConcatenator`	No description.

`concat`^Required

Type: IFragmentConcatenator

Methods

Name	Description
`ResolveList`	Resolves a list of string.
`ResolveMap`	Resolves a map token.
`ResolveNumberList`	Resolves a list of numbers.
`ResolveString`	Resolve string fragments to Tokens.
`ResolveToken`	Default Token resolution.

`ResolveList`

func ResolveList(xs *[]*string, context IResolveContext) interface{}

Resolves a list of string.

`xs`^Required

Type: _[]_string

`context`^Required

Type: IResolveContext

`ResolveMap`

func ResolveMap(xs *map[string]interface{}, context IResolveContext) interface{}

Resolves a map token.

`xs`^Required

Type: *map[string]interface{}

`context`^Required

Type: IResolveContext

`ResolveNumberList`

func ResolveNumberList(xs *[]*f64, context IResolveContext) interface{}

Resolves a list of numbers.

`xs`^Required

Type: _[]_f64

`context`^Required

Type: IResolveContext

`ResolveString`

func ResolveString(fragments TokenizedStringFragments, context IResolveContext) interface{}

Resolve string fragments to Tokens.

`fragments`^Required

Type: TokenizedStringFragments

`context`^Required

Type: IResolveContext

`ResolveToken`

func ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}

Default Token resolution.

Resolve the Token, recurse into whatever it returns, then finally post-process it.

DynamicListTerraformIterator

Initializers

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

cdktf.NewDynamicListTerraformIterator(list interface{}, mapKeyAttributeName *string) DynamicListTerraformIterator

Name	Type	Description
`list`	`interface{}`	No description.
`mapKeyAttributeName`	`*string`	No description.

`list`^Required

Type: interface{}

`mapKeyAttributeName`^Required

Type: *string

Methods

Name	Description
`Dynamic`	Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.
`ForExpressionForList`	Creates a for expression that results in a list.
`ForExpressionForMap`	Creates a for expression that results in a map.
`GetAny`	No description.
`GetAnyMap`	No description.
`GetBoolean`	No description.
`GetBooleanMap`	No description.
`GetList`	No description.
`GetMap`	No description.
`GetNumber`	No description.
`GetNumberList`	No description.
`GetNumberMap`	No description.
`GetString`	No description.
`GetStringMap`	No description.
`Keys`	Creates a for expression that maps the iterators to its keys.
`PluckProperty`	Creates a for expression that accesses the key on each element of the iterator.
`Values`	Creates a for expression that maps the iterators to its value in case it is a map.

`Dynamic`

func Dynamic(attributes *map[string]interface{}) IResolvable

Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString. See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes

`attributes`^Required

Type: *map[string]interface{}

`ForExpressionForList`

func ForExpressionForList(expression interface{}) IResolvable

Creates a for expression that results in a list.

This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.

You may write any valid Terraform for each expression, e.g. TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true") will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ].

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

`expression`^Required

Type: interface{}

The expression to use in the for mapping.

`ForExpressionForMap`

func ForExpressionForMap(keyExpression interface{}, valueExpression interface{}) IResolvable

Creates a for expression that results in a map.

This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.

You may write any valid Terraform for each expression, e.g. TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true") will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }.

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

`keyExpression`^Required

Type: interface{}

The expression to use as key in the for mapping.

`valueExpression`^Required

Type: interface{}

The expression to use as value in the for mapping.

`GetAny`

func GetAny(attribute *string) IResolvable

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetAnyMap`

func GetAnyMap(attribute *string) *map[string]interface{}

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetBoolean`

func GetBoolean(attribute *string) IResolvable

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetBooleanMap`

func GetBooleanMap(attribute *string) *map[string]*bool

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetList`

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

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetMap`

func GetMap(attribute *string) *map[string]interface{}

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetNumber`

func GetNumber(attribute *string) *f64

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetNumberList`

func GetNumberList(attribute *string) *[]*f64

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetNumberMap`

func GetNumberMap(attribute *string) *map[string]*f64

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetString`

func GetString(attribute *string) *string

`attribute`^Required

Type: *string

name of the property to retrieve.

`GetStringMap`

func GetStringMap(attribute *string) *map[string]*string

`attribute`^Required

Type: *string

name of the property to retrieve.

`Keys`

func Keys() IResolvable

Creates a for expression that maps the iterators to its keys.

For lists these would be the indices, for maps the keys. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

`PluckProperty`

func PluckProperty(property *string) IResolvable

Creates a for expression that accesses the key on each element of the iterator.

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

`property`^Required

Type: *string

The property of the iterators values to map to.

`Values`

func Values() IResolvable

Creates a for expression that maps the iterators to its value in case it is a map.

For lists these would stay the same. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

Static Functions

Name	Description
`FromComplexList`	Creates a new iterator from a complex list.
`FromDataSources`	Creates a new iterator from a data source that has been created with the `for_each` argument.
`FromList`	Creates a new iterator from a list.
`FromMap`	Creates a new iterator from a map.
`FromResources`	Creates a new iterator from a resource that has been created with the `for_each` argument.

`FromComplexList`

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

cdktf.DynamicListTerraformIterator_FromComplexList(list interface{}, mapKeyAttributeName *string) DynamicListTerraformIterator

Creates a new iterator from a complex list.

One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key.

Example

// Example automatically generated from non-compiling source. May contain errors.
cert := NewAcmCertificate(this, jsii.String("cert"), map[string]*string{
    "domainName": jsii.String("example.com"),
    "validationMethod": jsii.String("DNS"),
})

dvoIterator := terraformIterator_FromComplexList(cert.domainValidationOptions, jsii.String("domain_name"))

NewRoute53Record(this, jsii.String("record"), map[string]interface{}{
    "allowOverwrite": jsii.Boolean(true),
    "name": dvoIterator.getString(jsii.String("name")),
    "records": []interface{}{
        dvoIterator.getString(jsii.String("record")),
    },
    "ttl": jsii.Number(60),
    "type": dvoIterator.getString(jsii.String("type")),
    "zoneId": Token_asString(dataAwsRoute53ZoneExample.zoneId),
    "forEach": dvoIterator,
})

`list`^Required

Type: interface{}

the list to iterate over.

`mapKeyAttributeName`^Required

Type: *string

the name of the attribute that should be used as the key in the map.

Visit https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-on-complex-lists for more information.

`FromDataSources`

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

cdktf.DynamicListTerraformIterator_FromDataSources(resource ITerraformResource) ResourceTerraformIterator

Creates a new iterator from a data source that has been created with the for_each argument.

`resource`^Required

Type: ITerraformResource

`FromList`

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

cdktf.DynamicListTerraformIterator_FromList(list interface{}) ListTerraformIterator

Creates a new iterator from a list.

`list`^Required

Type: interface{}

`FromMap`

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

cdktf.DynamicListTerraformIterator_FromMap(map interface{}) MapTerraformIterator

Creates a new iterator from a map.

`map`^Required

Type: interface{}

`FromResources`

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

cdktf.DynamicListTerraformIterator_FromResources(resource ITerraformResource) ResourceTerraformIterator

Creates a new iterator from a resource that has been created with the for_each argument.

`resource`^Required

Type: ITerraformResource

Properties

Name	Type	Description
`Key`	`*string`	Returns the key of the current entry in the map that is being iterated over.
`Value`	`interface{}`	Returns the value of the current item iterated over.

`Key`^Required

func Key() *string

Type: *string

Returns the key of the current entry in the map that is being iterated over.

`Value`^Required

func Value() interface{}

Type: interface{}

Returns the value of the current item iterated over.

Fn

Initializers

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

cdktf.NewFn() Fn

Name	Type	Description

Static Functions

Name	Description
`Abs`	{@link https://developer.hashicorp.com/terraform/language/functions/abs abs} returns the absolute value of the given number. In other words, if the number is zero or positive then it is returned as-is, but if it is negative then it is multiplied by -1 to make it positive before returning it.
`Abspath`	{@link https://developer.hashicorp.com/terraform/language/functions/abspath abspath} takes a string containing a filesystem path and converts it to an absolute path. That is, if the path is not absolute, it will be joined with the current working directory.
`Alltrue`	{@link https://developer.hashicorp.com/terraform/language/functions/alltrue alltrue} returns `true` if all elements in a given collection are `true` or `"true"`. It also returns `true` if the collection is empty.
`Anytrue`	{@link https://developer.hashicorp.com/terraform/language/functions/anytrue anytrue} returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty.
`Base64decode`	{@link https://developer.hashicorp.com/terraform/language/functions/base64decode base64decode} takes a string containing a Base64 character sequence and returns the original string.
`Base64encode`	{@link https://developer.hashicorp.com/terraform/language/functions/base64encode base64encode} applies Base64 encoding to a string.
`Base64gzip`	{@link https://developer.hashicorp.com/terraform/language/functions/base64gzip base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding.
`Base64sha256`	{@link https://developer.hashicorp.com/terraform/language/functions/base64sha256 base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation.
`Base64sha512`	{@link https://developer.hashicorp.com/terraform/language/functions/base64sha512 base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation.
`Basename`	{@link https://developer.hashicorp.com/terraform/language/functions/basename basename} takes a string containing a filesystem path and removes all except the last portion from it.
`Can`	{@link https://developer.hashicorp.com/terraform/language/functions/can can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors.
`Ceil`	{@link https://developer.hashicorp.com/terraform/language/functions/ceil ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction.
`Chomp`	{@link https://developer.hashicorp.com/terraform/language/functions/chomp chomp} removes newline characters at the end of a string.
`Chunklist`	{@link https://developer.hashicorp.com/terraform/language/functions/chunklist chunklist} splits a single list into fixed-size chunks, returning a list of lists.
`Cidrhost`	{@link https://developer.hashicorp.com/terraform/language/functions/cidrhost cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix.
`Cidrnetmask`	{@link https://developer.hashicorp.com/terraform/language/functions/cidrnetmask cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address.
`Cidrsubnet`	{@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnet cidrsubnet} calculates a subnet address within given IP network address prefix.
`Cidrsubnets`	{@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnets cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix.
`Coalesce`	{@link https://developer.hashicorp.com/terraform/language/functions/coalesce coalesce} takes any number of arguments and returns the first one that isn't null or an empty string.
`Coalescelist`	{@link https://developer.hashicorp.com/terraform/language/functions/coalescelist coalescelist} takes any number of list arguments and returns the first one that isn't empty.
`Compact`	{@link https://developer.hashicorp.com/terraform/language/functions/compact compact} takes a list of strings and returns a new list with any empty string elements removed.
`Concat`	{@link https://developer.hashicorp.com/terraform/language/functions/concat concat} takes two or more lists and combines them into a single list.
`Contains`	{@link https://developer.hashicorp.com/terraform/language/functions/contains contains} determines whether a given list or set contains a given single value as one of its elements.
`Csvdecode`	{@link https://developer.hashicorp.com/terraform/language/functions/csvdecode csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data.
`Dirname`	{@link https://developer.hashicorp.com/terraform/language/functions/dirname dirname} takes a string containing a filesystem path and removes the last portion from it.
`Distinct`	{@link https://developer.hashicorp.com/terraform/language/functions/distinct distinct} takes a list and returns a new list with any duplicate elements removed.
`Element`	{@link https://developer.hashicorp.com/terraform/language/functions/element element} retrieves a single element from a list.
`Endswith`	{@link https://developer.hashicorp.com/terraform/language/functions/endswith endswith} takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix.
`File`	{@link https://developer.hashicorp.com/terraform/language/functions/file file} reads the contents of a file at the given path and returns them as a string.
`Filebase64`	{@link https://developer.hashicorp.com/terraform/language/functions/filebase64 filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string.
`Filebase64sha256`	{@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha256 filebase64sha256} is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string.
`Filebase64sha512`	{@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha512 filebase64sha512} is a variant of `base64sha512` that hashes the contents of a given file rather than a literal string.
`Fileexists`	{@link https://developer.hashicorp.com/terraform/language/functions/fileexists fileexists} determines whether a file exists at a given path.
`Filemd5`	{@link https://developer.hashicorp.com/terraform/language/functions/filemd5 filemd5} is a variant of `md5` that hashes the contents of a given file rather than a literal string.
`Fileset`	{@link https://developer.hashicorp.com/terraform/language/functions/fileset fileset} enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (`/`) as the path separator for cross-system compatibility.
`Filesha1`	{@link https://developer.hashicorp.com/terraform/language/functions/filesha1 filesha1} is a variant of `sha1` that hashes the contents of a given file rather than a literal string.
`Filesha256`	{@link https://developer.hashicorp.com/terraform/language/functions/filesha256 filesha256} is a variant of `sha256` that hashes the contents of a given file rather than a literal string.
`Filesha512`	{@link https://developer.hashicorp.com/terraform/language/functions/filesha512 filesha512} is a variant of `sha512` that hashes the contents of a given file rather than a literal string.
`Flatten`	{@link https://developer.hashicorp.com/terraform/language/functions/flatten flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents.
`Floor`	{@link https://developer.hashicorp.com/terraform/language/functions/floor floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction.
`Format`	The {@link https://developer.hashicorp.com/terraform/language/functions/format format} function produces a string by formatting a number of other values according to a specification string. It is similar to the `printf` function in C, and other similar functions in other programming languages.
`Formatdate`	{@link https://developer.hashicorp.com/terraform/language/functions/formatdate formatdate} converts a timestamp into a different time format.
`Formatlist`	{@link https://developer.hashicorp.com/terraform/language/functions/formatlist formatlist} produces a list of strings by formatting a number of other values according to a specification string.
`Indent`	{@link https://developer.hashicorp.com/terraform/language/functions/indent indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string.
`Index`	{@link https://developer.hashicorp.com/terraform/language/functions/index index} finds the element index for a given value in a list.
`Jsondecode`	{@link https://developer.hashicorp.com/terraform/language/functions/jsondecode jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string.
`Jsonencode`	{@link https://developer.hashicorp.com/terraform/language/functions/jsonencode jsonencode} encodes a given value to a string using JSON syntax.
`Keys`	{@link https://developer.hashicorp.com/terraform/language/functions/keys keys} takes a map and returns a list containing the keys from that map.
`LengthOf`	{@link https://developer.hashicorp.com/terraform/language/functions/length length} determines the length of a given list, map, or string.
`Log`	{@link https://developer.hashicorp.com/terraform/language/functions/log log} returns the logarithm of a given number in a given base.
`Lower`	{@link https://developer.hashicorp.com/terraform/language/functions/lower lower} converts all cased letters in the given string to lowercase.
`Matchkeys`	{@link https://developer.hashicorp.com/terraform/language/functions/matchkeys matchkeys} constructs a new list by taking a subset of elements from one list whose indexes match the corresponding indexes of values in another list.
`Max`	{@link https://developer.hashicorp.com/terraform/language/functions/max max} takes one or more numbers and returns the greatest number from the set.
`Md5`	{@link https://developer.hashicorp.com/terraform/language/functions/md5 md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits.
`Merge`	{@link https://developer.hashicorp.com/terraform/language/functions/merge merge} takes an arbitrary number of maps or objects, and returns a single map or object that contains a merged set of elements from all arguments.
`Min`	{@link https://developer.hashicorp.com/terraform/language/functions/min min} takes one or more numbers and returns the smallest number from the set.
`Nonsensitive`	{@link https://developer.hashicorp.com/terraform/language/functions/nonsensitive nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value.
`One`	{@link https://developer.hashicorp.com/terraform/language/functions/one one} takes a list, set, or tuple value with either zero or one elements. If the collection is empty, `one` returns `null`. Otherwise, `one` returns the first element. If there are two or more elements then `one` will return an error.
`Parseint`	{@link https://developer.hashicorp.com/terraform/language/functions/parseint parseint} parses the given string as a representation of an integer in the specified base and returns the resulting number. The base must be between 2 and 62 inclusive.
`Pathexpand`	{@link https://developer.hashicorp.com/terraform/language/functions/pathexpand pathexpand} takes a filesystem path that might begin with a `~` segment, and if so it replaces that segment with the current user's home directory path.
`Plantimestamp`	{@link https://developer.hashicorp.com/terraform/language/functions/plantimestamp plantimestamp} returns a UTC timestamp string in RFC 3339 format, fixed to a constant time representing the time of the plan.
`Pow`	{@link https://developer.hashicorp.com/terraform/language/functions/pow pow} calculates an exponent, by raising its first argument to the power of the second argument.
`Regex`	{@link https://developer.hashicorp.com/terraform/language/functions/regex regex} applies a regular expression to a string and returns the matching substrings.
`Regexall`	{@link https://developer.hashicorp.com/terraform/language/functions/regexall regexall} applies a regular expression to a string and returns a list of all matches.
`Replace`	{@link https://developer.hashicorp.com/terraform/language/functions/replace replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string.
`Reverse`	{@link https://developer.hashicorp.com/terraform/language/functions/reverse reverse} takes a sequence and produces a new sequence of the same length with all of the same elements as the given sequence but in reverse order.
`Rsadecrypt`	{@link https://developer.hashicorp.com/terraform/language/functions/rsadecrypt rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext.
`Sensitive`	{@link https://developer.hashicorp.com/terraform/language/functions/sensitive sensitive} takes any value and returns a copy of it marked so that Terraform will treat it as sensitive, with the same meaning and behavior as for sensitive input variables.
`Setintersection`	The {@link https://developer.hashicorp.com/terraform/language/functions/setintersection setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. In other words, it computes the intersection of the sets.
`Setproduct`	The {@link https://developer.hashicorp.com/terraform/language/functions/setproduct setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product.
`Setsubtract`	The {@link https://developer.hashicorp.com/terraform/language/functions/setsubtract setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. In other words, it computes the relative complement of the second set.
`Setunion`	The {@link https://developer.hashicorp.com/terraform/language/functions/setunion setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. In other words, it computes the union of the sets.
`Sha1`	{@link https://developer.hashicorp.com/terraform/language/functions/sha1 sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits.
`Sha256`	{@link https://developer.hashicorp.com/terraform/language/functions/sha256 sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits.
`Sha512`	{@link https://developer.hashicorp.com/terraform/language/functions/sha512 sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits.
`Signum`	{@link https://developer.hashicorp.com/terraform/language/functions/signum signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign.
`Slice`	{@link https://developer.hashicorp.com/terraform/language/functions/slice slice} extracts some consecutive elements from within a list.
`Sort`	{@link https://developer.hashicorp.com/terraform/language/functions/sort sort} takes a list of strings and returns a new list with those strings sorted lexicographically.
`Split`	{@link https://developer.hashicorp.com/terraform/language/functions/split split} produces a list by dividing a given string at all occurrences of a given separator.
`Startswith`	{@link https://developer.hashicorp.com/terraform/language/functions/startswith startswith} takes two values: a string to check and a prefix string. The function returns true if the string begins with that exact prefix.
`Strcontains`	{@link https://developer.hashicorp.com/terraform/language/functions/strcontains strcontains} takes two values: a string to check and an expected substring. The function returns true if the string has the substring contained within it.
`Strrev`	{@link https://developer.hashicorp.com/terraform/language/functions/strrev strrev} reverses the characters in a string. Note that the characters are treated as Unicode characters (in technical terms, Unicode grapheme cluster boundaries are respected).
`Substr`	{@link https://developer.hashicorp.com/terraform/language/functions/substr substr} extracts a substring from a given string by offset and (maximum) length.
`Sum`	{@link https://developer.hashicorp.com/terraform/language/functions/sum sum} takes a list or set of numbers and returns the sum of those numbers.
`Templatefile`	{@link https://developer.hashicorp.com/terraform/language/functions/templatefile templatefile} reads the file at the given path and renders its content as a template using a supplied set of template variables.
`Textdecodebase64`	{@link https://developer.hashicorp.com/terraform/language/functions/textdecodebase64 textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding.
`Textencodebase64`	{@link https://developer.hashicorp.com/terraform/language/functions/textencodebase64 textencodebase64} encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters.
`Timeadd`	{@link https://developer.hashicorp.com/terraform/language/functions/timeadd timeadd} adds a duration to a timestamp, returning a new timestamp.
`Timecmp`	{@link https://developer.hashicorp.com/terraform/language/functions/timecmp timecmp} compares two timestamps and returns a number that represents the ordering of the instants those timestamps represent.
`Timestamp`	{@link https://developer.hashicorp.com/terraform/language/functions/timestamp timestamp} returns a UTC timestamp string in RFC 3339 format.
`Title`	{@link https://developer.hashicorp.com/terraform/language/functions/title title} converts the first letter of each word in the given string to uppercase.
`Tobool`	{@link https://developer.hashicorp.com/terraform/language/functions/tobool tobool} converts its argument to a boolean value.
`Tolist`	{@link https://developer.hashicorp.com/terraform/language/functions/tolist tolist} converts its argument to a list value.
`Tomap`	{@link https://developer.hashicorp.com/terraform/language/functions/tomap tomap} converts its argument to a map value.
`Tonumber`	{@link https://developer.hashicorp.com/terraform/language/functions/tonumber tonumber} converts its argument to a number value.
`Toset`	{@link https://developer.hashicorp.com/terraform/language/functions/toset toset} converts its argument to a set value.

Go: Classes

Annotations

Methods

AddError

messageRequired

AddInfo

messageRequired

AddWarning

messageRequired

Static Functions

Of

scopeRequired

AnyListList

Initializers

terraformResourceRequired

terraformAttributeRequired

wrapsSetRequired

Methods

AllWithMapKey

mapKeyAttributeNameRequired

ComputeFqn

Resolve

_contextRequired

ToString

Get

indexRequired

Properties

CreationStackRequired

FqnRequired

AnyListMap

Initializers

terraformResourceRequired

terraformAttributeRequired

Methods

ComputeFqn

InterpolationForAttribute

propertyRequired

Resolve

_contextRequired

ToString

Get

keyRequired

Properties

CreationStackRequired

FqnRequired

AnyMap

Initializers

terraformResourceRequired

terraformAttributeRequired

Methods

ComputeFqn

Lookup

keyRequired

Resolve

_contextRequired

ToString

Properties

CreationStackRequired

FqnRequired

AnyMapList

Initializers

terraformResourceRequired

terraformAttributeRequired

wrapsSetRequired

Methods

ComputeFqn

InterpolationForAttribute

propertyRequired

Resolve

_contextRequired

ToString

Get

indexRequired

Properties

CreationStackRequired

FqnRequired

Aspects

Methods

Add

aspectRequired

`AddError`

`message`^Required

`AddInfo`

`message`^Required

`AddWarning`

`message`^Required

`Of`

`scope`^Required

`terraformResource`^Required

`terraformAttribute`^Required

`wrapsSet`^Required

`AllWithMapKey`

`mapKeyAttributeName`^Required

`ComputeFqn`

`Resolve`

`_context`^Required

`ToString`

`Get`

`index`^Required

`CreationStack`^Required

`Fqn`^Required

`terraformResource`^Required

`terraformAttribute`^Required

`ComputeFqn`

`InterpolationForAttribute`

`property`^Required

`Resolve`

`_context`^Required

`ToString`

`Get`

`key`^Required

`CreationStack`^Required

`Fqn`^Required

`terraformResource`^Required

`terraformAttribute`^Required

`ComputeFqn`

`Lookup`

`key`^Required

`Resolve`

`_context`^Required

`ToString`

`CreationStack`^Required

`Fqn`^Required

`terraformResource`^Required

`terraformAttribute`^Required

`wrapsSet`^Required

`ComputeFqn`

`InterpolationForAttribute`

`property`^Required

`Resolve`

`_context`^Required

`ToString`

`Get`

`index`^Required

`CreationStack`^Required

`Fqn`^Required

`Add`

`aspect`^Required

`Of`

`scope`^Required

`All`^Required

`message`^Required

`pass`^Required

`Message`^Required

`Pass`^Required

`terraformResource`^Required

`terraformAttribute`^Required

`wrapsSet`^Required

`AllWithMapKey`

`mapKeyAttributeName`^Required

`ComputeFqn`

`Resolve`

`_context`^Required

`ToString`

`Get`

`index`^Required

`CreationStack`^Required

`Fqn`^Required

`terraformResource`^Required

`terraformAttribute`^Required