cdktf

package module
v0.9.0-pre.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 1, 2021 License: MPL-2.0 Imports: 5 Imported by: 85,675

README

cdktf

cdktf is a framework for defining cloud infrastructure using Terraform providers and modules. It allows for users to define infrastructure resources using higher-level programming languages.

Build

Install dependencies

yarn install

Build the package

yarn build

Documentation

Overview

Cloud Development Kit for Terraform

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func App_IsConstruct added in v0.6.0

func App_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func ArtifactoryBackend_IsConstruct added in v0.6.0

func ArtifactoryBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func AzurermBackend_IsConstruct added in v0.6.0

func AzurermBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func ConsulBackend_IsConstruct added in v0.6.0

func ConsulBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CosBackend_IsConstruct added in v0.6.0

func CosBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateArtifactory_IsConstruct added in v0.6.0

func DataTerraformRemoteStateArtifactory_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateAzurerm_IsConstruct added in v0.6.0

func DataTerraformRemoteStateAzurerm_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateConsul_IsConstruct added in v0.6.0

func DataTerraformRemoteStateConsul_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateCos_IsConstruct added in v0.6.0

func DataTerraformRemoteStateCos_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateEtcdV3_IsConstruct added in v0.6.0

func DataTerraformRemoteStateEtcdV3_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateEtcd_IsConstruct added in v0.6.0

func DataTerraformRemoteStateEtcd_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateGcs_IsConstruct added in v0.6.0

func DataTerraformRemoteStateGcs_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateHttp_IsConstruct added in v0.6.0

func DataTerraformRemoteStateHttp_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateLocal_IsConstruct added in v0.6.0

func DataTerraformRemoteStateLocal_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateManta_IsConstruct added in v0.6.0

func DataTerraformRemoteStateManta_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateOss_IsConstruct added in v0.6.0

func DataTerraformRemoteStateOss_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStatePg_IsConstruct added in v0.6.0

func DataTerraformRemoteStatePg_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateS3_IsConstruct added in v0.6.0

func DataTerraformRemoteStateS3_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteStateSwift_IsConstruct added in v0.6.0

func DataTerraformRemoteStateSwift_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func DataTerraformRemoteState_IsConstruct added in v0.6.0

func DataTerraformRemoteState_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func EtcdBackend_IsConstruct added in v0.6.0

func EtcdBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func EtcdV3Backend_IsConstruct added in v0.6.0

func EtcdV3Backend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Fn_Abs added in v0.6.0

func Fn_Abs(value interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/abs.html abs} returns the absolute value of the given number. Experimental.

func Fn_Abspath added in v0.6.0

func Fn_Abspath(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/abspath.html abspath} takes a string containing a filesystem path and converts it to an absolute path. Experimental.

func Fn_Base64decode added in v0.6.0

func Fn_Base64decode(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/base64decode.html base64decode} takes a string containing a Base64 character sequence and returns the original string. Experimental.

func Fn_Base64encode added in v0.6.0

func Fn_Base64encode(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/base64encode.html base64encode} takes a string containing a Base64 character sequence and returns the original string. Experimental.

func Fn_Base64gzip added in v0.6.0

func Fn_Base64gzip(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/base64gzip.html base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding. Experimental.

func Fn_Base64sha256 added in v0.6.0

func Fn_Base64sha256(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/base64sha256.html base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. Experimental.

func Fn_Base64sha512 added in v0.6.0

func Fn_Base64sha512(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/base64sha512.html base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. Experimental.

func Fn_Basename added in v0.6.0

func Fn_Basename(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/basename.html basename} takes a string containing a filesystem path and removes all except the last portion from it. Experimental.

func Fn_Bcrypt added in v0.6.0

func Fn_Bcrypt(value interface{}, cost interface{}) *string

{@link https://www.terraform.io/docs/language/functions/bcrypt.html bcrypt} computes a hash of the given string using the Blowfish cipher, returning a string in the Modular Crypt Format usually expected in the shadow password file on many Unix systems. Experimental.

func Fn_Ceil added in v0.6.0

func Fn_Ceil(value interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/ceil.html ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction. Experimental.

func Fn_Chomp added in v0.6.0

func Fn_Chomp(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/chomp.html chomp} removes newline characters at the end of a string. Experimental.

func Fn_Chunklist added in v0.6.0

func Fn_Chunklist(value *[]interface{}, chunkSize interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/chunklist.html chunklist} splits a single list into fixed-size chunks, returning a list of lists. Experimental.

func Fn_Cidrhost added in v0.6.0

func Fn_Cidrhost(prefix interface{}, hostnum interface{}) *string

{@link https://www.terraform.io/docs/language/functions/cidrhost.html cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix. Experimental.

func Fn_Cidrnetmask added in v0.6.0

func Fn_Cidrnetmask(prefix interface{}) *string

{@link https://www.terraform.io/docs/language/functions/cidrnetmask.html cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address. Experimental.

func Fn_Cidrsubnet added in v0.6.0

func Fn_Cidrsubnet(prefix interface{}, newbits interface{}, netnum interface{}) *string

{@link https://www.terraform.io/docs/language/functions/cidrsubnet.html cidrsubnet} calculates a subnet address within given IP network address prefix. Experimental.

func Fn_Cidrsubnets added in v0.6.0

func Fn_Cidrsubnets(prefix interface{}, newbits *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/cidrsubnets.html cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix. Experimental.

func Fn_Coalescelist added in v0.6.0

func Fn_Coalescelist(value *[]*[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/coalescelist.html coalescelist} takes any number of list arguments and returns the first one that isn't empty. Experimental.

func Fn_Compact added in v0.6.0

func Fn_Compact(value *[]*string) *[]*string

{@link https://www.terraform.io/docs/language/functions/compact.html compact} takes a list of strings and returns a new list with any empty string elements removed. Experimental.

func Fn_Concat added in v0.6.0

func Fn_Concat(value *[]*[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/concat.html concat} takes two or more lists and combines them into a single list. Experimental.

func Fn_Csvdecode added in v0.6.0

func Fn_Csvdecode(value interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/csvdecode.html csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data. Experimental.

func Fn_Dirname added in v0.6.0

func Fn_Dirname(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/dirname.html dirname} takes a string containing a filesystem path and removes the last portion from it. Experimental.

func Fn_Distinct added in v0.6.0

func Fn_Distinct(list *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/distinct.html distinct} takes a list and returns a new list with any duplicate elements removed. Experimental.

func Fn_Element added in v0.6.0

func Fn_Element(list interface{}, index interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/element.html element} retrieves a single element from a list. Experimental.

func Fn_File added in v0.6.0

func Fn_File(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/file.html file} takes a string containing a filesystem path and removes all except the last portion from it. Experimental.

func Fn_Filebase64 added in v0.6.0

func Fn_Filebase64(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filebase64.html filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string. Experimental.

func Fn_Filebase64sha256 added in v0.6.0

func Fn_Filebase64sha256(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filebase64sha256.html filebase64sha256} is a variant of base64sha256 that hashes the contents of a given file rather than a literal string. Experimental.

func Fn_Filebase64sha512 added in v0.6.0

func Fn_Filebase64sha512(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filebase64sha512.html filebase64sha512} is a variant of base64sha512 that hashes the contents of a given file rather than a literal string. Experimental.

func Fn_Filemd5 added in v0.6.0

func Fn_Filemd5(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filemd5.html filemd5} is a variant of md5 that hashes the contents of a given file rather than a literal string. Experimental.

func Fn_Fileset added in v0.6.0

func Fn_Fileset(path interface{}, pattern interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/fileset.html fileset} enumerates a set of regular file names given a path and pattern. Experimental.

func Fn_Filesha1 added in v0.6.0

func Fn_Filesha1(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filesha1.html filesha1} is a variant of sha1 that hashes the contents of a given file rather than a literal string. Experimental.

func Fn_Filesha256 added in v0.6.0

func Fn_Filesha256(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filesha256.html filesha256} is a variant of sha256 that hashes the contents of a given file rather than a literal string. Experimental.

func Fn_Filesha512 added in v0.6.0

func Fn_Filesha512(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/filesha512.html filesha512} is a variant of sha512 that hashes the contents of a given file rather than a literal string. Experimental.

func Fn_Flatten added in v0.6.0

func Fn_Flatten(list interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/flatten.html flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents. Experimental.

func Fn_Floor added in v0.6.0

func Fn_Floor(value interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/floor.html floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction. Experimental.

func Fn_Format added in v0.6.0

func Fn_Format(spec interface{}, values *[]interface{}) *string

{@link https://www.terraform.io/docs/language/functions/format.html format} produces a string by formatting a number of other values according to a specification string. Experimental.

func Fn_Formatdate added in v0.6.0

func Fn_Formatdate(spec interface{}, timestamp interface{}) *string

{@link https://www.terraform.io/docs/language/functions/formatdate.html formatdate} converts a timestamp into a different time format. Experimental.

func Fn_Formatlist added in v0.6.0

func Fn_Formatlist(spec interface{}, values *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/formatlist.html formatlist} produces a list of strings by formatting a number of other values according to a specification string. Experimental.

func Fn_Indent added in v0.6.0

func Fn_Indent(indentation interface{}, value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/indent.html indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. Experimental.

func Fn_Index added in v0.6.0

func Fn_Index(list interface{}, value interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/index.html index} finds the element index for a given value in a list. Experimental.

func Fn_Join added in v0.6.0

func Fn_Join(separator interface{}, value *[]interface{}) *string

{@link https://www.terraform.io/docs/language/functions/join.html join} produces a string by concatenating together all elements of a given list of strings with the given delimiter. Experimental.

func Fn_Jsondecode added in v0.6.0

func Fn_Jsondecode(value interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/jsondecode.html jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string. Experimental.

func Fn_Jsonencode added in v0.6.0

func Fn_Jsonencode(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/jsonencode.html jsonencode} encodes a given value to a string using JSON syntax. Experimental.

func Fn_Keys added in v0.6.0

func Fn_Keys(map_ interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/keys.html keys} takes a map and returns a list containing the keys from that map. Experimental.

func Fn_LengthOf added in v0.6.0

func Fn_LengthOf(value interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/length.html length} determines the length of a given list, map, or string. Experimental.

func Fn_Log added in v0.6.0

func Fn_Log(value interface{}, base interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/log.html log} returns the logarithm of a given number in a given base. Experimental.

func Fn_Lookup added in v0.6.0

func Fn_Lookup(value interface{}, key interface{}, defaultValue interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/lookup.html lookup} retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead. Experimental.

func Fn_Lower added in v0.6.0

func Fn_Lower(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/lower.html lower} converts all cased letters in the given string to lowercase. Experimental.

func Fn_Matchkeys added in v0.6.0

func Fn_Matchkeys(valuesList interface{}, keysList interface{}, searchSet interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/matchkeys.html 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. Experimental.

func Fn_Max added in v0.6.0

func Fn_Max(values *[]interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/max.html max} takes one or more numbers and returns the greatest number from the set. Experimental.

func Fn_Md5 added in v0.6.0

func Fn_Md5(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/md5.html md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits. Experimental.

func Fn_Merge added in v0.6.0

func Fn_Merge(values *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/merge.html 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. Experimental.

func Fn_Min added in v0.6.0

func Fn_Min(values *[]interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/min.html min} takes one or more numbers and returns the smallest number from the set. Experimental.

func Fn_Nonsensitive added in v0.6.0

func Fn_Nonsensitive(expression interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/nonsensitive.html nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value. Experimental.

func Fn_One added in v0.6.0

func Fn_One(list interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/one.html one} takes a list, set, or tuple value with either zero or one elements. Experimental.

func Fn_ParseInt added in v0.6.0

func Fn_ParseInt(value interface{}, base interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/parseint.html 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. Experimental.

func Fn_Pathexpand added in v0.6.0

func Fn_Pathexpand(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/pathexpand.html pathexpand} takes a string containing a filesystem path and removes the last portion from it. Experimental.

func Fn_Pow added in v0.6.0

func Fn_Pow(value interface{}, power interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/pow.html pow} calculates an exponent, by raising its first argument to the power of the second argument. Experimental.

func Fn_Range added in v0.6.0

func Fn_Range(start interface{}, limit interface{}, step *float64) *[]*string

{@link https://www.terraform.io/docs/language/functions/range.html range} generates a list of numbers using a start value, a limit value, and a step value. Experimental.

func Fn_RawString added in v0.8.0

func Fn_RawString(str *string) *string

Use this function to wrap a string and escape it properly for the use in Terraform This is only needed in certain scenarios (e.g., if you have unescaped double quotes in the string). Experimental.

func Fn_Regexall added in v0.6.0

func Fn_Regexall(pattern interface{}, value interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/regexall.html regexall} applies a regular expression to a string and returns a list of all matches. Experimental.

func Fn_Replace added in v0.6.0

func Fn_Replace(value interface{}, substring interface{}, replacement interface{}) *string

{@link https://www.terraform.io/docs/language/functions/replace.html replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string. Experimental.

func Fn_Reverse added in v0.6.0

func Fn_Reverse(values *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/reverse.html 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. Experimental.

func Fn_Rsadecrypt added in v0.6.0

func Fn_Rsadecrypt(ciphertext interface{}, privatekey interface{}) *string

{@link https://www.terraform.io/docs/language/functions/rsadecrypt.html rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext. Experimental.

func Fn_Sensitive added in v0.6.0

func Fn_Sensitive(expression interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/sensitive.html 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. Experimental.

func Fn_Setintersection added in v0.6.0

func Fn_Setintersection(values *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/setintersection.html setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. Experimental.

func Fn_Setproduct added in v0.6.0

func Fn_Setproduct(values *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/setproduct.html setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product. Experimental.

func Fn_Setsubtract added in v0.6.0

func Fn_Setsubtract(minuend interface{}, subtrahend interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/slice.html setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. Experimental.

func Fn_Setunion added in v0.6.0

func Fn_Setunion(values *[]interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/setunion.html setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. Experimental.

func Fn_Sha1 added in v0.6.0

func Fn_Sha1(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/sha1.html sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits. Experimental.

func Fn_Sha256 added in v0.6.0

func Fn_Sha256(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/sha256.html sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits. Experimental.

func Fn_Sha512 added in v0.6.0

func Fn_Sha512(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/sha512.html sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits. Experimental.

func Fn_Signum added in v0.6.0

func Fn_Signum(value interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/signum.html signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign. Experimental.

func Fn_Slice added in v0.6.0

func Fn_Slice(list interface{}, startindex interface{}, endindex interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/slice.html slice} extracts some consecutive elements from within a list. Experimental.

func Fn_Sort added in v0.6.0

func Fn_Sort(list interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/sort.html sort} takes a list of strings and returns a new list with those strings sorted lexicographically. Experimental.

func Fn_Split added in v0.6.0

func Fn_Split(seperator interface{}, value interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/split.html split} produces a list by dividing a given string at all occurrences of a given separator. Experimental.

func Fn_Strrev added in v0.6.0

func Fn_Strrev(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/strrev.html strrev} reverses the characters in a string. Experimental.

func Fn_Substr added in v0.6.0

func Fn_Substr(value interface{}, offset interface{}, length interface{}) *string

{@link https://www.terraform.io/docs/language/functions/substr.html substr} extracts a substring from a given string by offset and length. Experimental.

func Fn_Sum added in v0.6.0

func Fn_Sum(list interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/sum.html sum} takes a list or set of numbers and returns the sum of those numbers. Experimental.

func Fn_Templatefile added in v0.6.0

func Fn_Templatefile(path interface{}, vars interface{}) *string

{@link https://www.terraform.io/docs/language/functions/templatefile.html templatefile} reads the file at the given path and renders its content as a template using a supplied set of template variables. Experimental.

func Fn_Textdecodebase64 added in v0.6.0

func Fn_Textdecodebase64(value interface{}, encodingName interface{}) *string

{@link https://www.terraform.io/docs/language/functions/textdecodebase64.html textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. Experimental.

func Fn_Textencodebase64 added in v0.6.0

func Fn_Textencodebase64(value interface{}, encodingName interface{}) *string

{@link https://www.terraform.io/docs/language/functions/textencodebase64.html 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. Experimental.

func Fn_Timeadd added in v0.6.0

func Fn_Timeadd(timestamp interface{}, duration interface{}) *string

{@link https://www.terraform.io/docs/language/functions/timeadd.html timeadd} adds a duration to a timestamp, returning a new timestamp. Experimental.

func Fn_Timestamp added in v0.6.0

func Fn_Timestamp() *string

{@link https://www.terraform.io/docs/language/functions/timestamp.html timestamp} returns a UTC timestamp string in RFC 3339 format. Experimental.

func Fn_Title added in v0.6.0

func Fn_Title(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/title.html title} converts the first letter of each word in the given string to uppercase. Experimental.

func Fn_Tolist added in v0.6.0

func Fn_Tolist(expression interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/tolist.html tolist} converts its argument to a list value. Experimental.

func Fn_Tomap added in v0.6.0

func Fn_Tomap(expression interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/tomap.html tomap} converts its argument to a map value. Experimental.

func Fn_Tonumber added in v0.6.0

func Fn_Tonumber(expression interface{}) *float64

{@link https://www.terraform.io/docs/language/functions/tonumber.html tonumber} converts its argument to a number value. Experimental.

func Fn_Toset added in v0.6.0

func Fn_Toset(expression interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/toset.html toset} converts its argument to a set value. Experimental.

func Fn_Tostring added in v0.6.0

func Fn_Tostring(expression interface{}) *string

{@link https://www.terraform.io/docs/language/functions/tostring.html tostring} converts its argument to a string value. Experimental.

func Fn_Transpose added in v0.6.0

func Fn_Transpose(value interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/transpose.html transpose} takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings. Experimental.

func Fn_Trim added in v0.6.0

func Fn_Trim(value interface{}, replacement interface{}) *string

{@link https://www.terraform.io/docs/language/functions/trim.html trim} removes the specified characters from the start and end of the given string. Experimental.

func Fn_Trimprefix added in v0.6.0

func Fn_Trimprefix(value interface{}, prefix interface{}) *string

{@link https://www.terraform.io/docs/language/functions/trimprefix.html trimprefix} removes the specified prefix from the start of the given string. Experimental.

func Fn_Trimspace added in v0.6.0

func Fn_Trimspace(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/trimspace.html trimspace} removes any space characters from the start and end of the given string. Experimental.

func Fn_Trimsuffix added in v0.6.0

func Fn_Trimsuffix(value interface{}, suffix interface{}) *string

{@link https://www.terraform.io/docs/language/functions/trimsuffix.html trimsuffix} removes the specified suffix from the end of the given string. Experimental.

func Fn_Try added in v0.6.0

func Fn_Try(expression *[]interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/try.html try} evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. Experimental.

func Fn_Upper added in v0.6.0

func Fn_Upper(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/upper.html upper} converts all cased letters in the given string to uppercase. Experimental.

func Fn_Urlencode added in v0.6.0

func Fn_Urlencode(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/urlencode.html urlencode} applies URL encoding to a given string. Experimental.

func Fn_Uuid added in v0.6.0

func Fn_Uuid() *string

{@link https://www.terraform.io/docs/language/functions/uuid.html uuid} generates a unique identifier string. Experimental.

func Fn_Uuidv5 added in v0.6.0

func Fn_Uuidv5(namespace interface{}, name interface{}) *string

{@link https://www.terraform.io/docs/language/functions/uuidv5.html uuidv5} generates a unique identifier string. Experimental.

func Fn_Values added in v0.6.0

func Fn_Values(value interface{}) *[]*string

{@link https://www.terraform.io/docs/language/functions/values.html values} takes a map and returns a list containing the values of the elements in that map. Experimental.

func Fn_Yamldecode added in v0.6.0

func Fn_Yamldecode(value interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/yamldecode.html yamldecode} parses a string as a subset of YAML, and produces a representation of its value. Experimental.

func Fn_Yamlencode added in v0.6.0

func Fn_Yamlencode(value interface{}) *string

{@link https://www.terraform.io/docs/language/functions/yamlencode.html yamlencode} encodes a given value to a string using JSON syntax. Experimental.

func Fn_Zipmap added in v0.6.0

func Fn_Zipmap(keyslist *[]interface{}, valueslist *[]interface{}) interface{}

{@link https://www.terraform.io/docs/language/functions/zipmap.html zipmap} constructs a map from a list of keys and a corresponding list of values. Experimental.

func GcsBackend_IsConstruct added in v0.6.0

func GcsBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func HttpBackend_IsConstruct added in v0.6.0

func HttpBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Lazy_ListValue

func Lazy_ListValue(producer IListProducer, options *LazyListValueOptions) *[]*string

Returns a list-ified token for a lazy value. Experimental.

func Lazy_NumberValue

func Lazy_NumberValue(producer INumberProducer) *float64

Returns a numberified token for a lazy value. Experimental.

func Lazy_StringValue

func Lazy_StringValue(producer IStringProducer, options *LazyStringValueOptions) *string

Returns a stringified token for a lazy value. Experimental.

func LocalBackend_IsConstruct added in v0.6.0

func LocalBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Manifest_FileName

func Manifest_FileName() *string

func Manifest_StackFileName

func Manifest_StackFileName() *string

func Manifest_StacksFolder

func Manifest_StacksFolder() *string

func MantaBackend_IsConstruct added in v0.6.0

func MantaBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewApp_Override

func NewApp_Override(a App, options *AppOptions)

Defines an app. Experimental.

func NewArtifactoryBackend_Override

func NewArtifactoryBackend_Override(a ArtifactoryBackend, scope constructs.Construct, props *ArtifactoryBackendProps)

Experimental.

func NewAzurermBackend_Override

func NewAzurermBackend_Override(a AzurermBackend, scope constructs.Construct, props *AzurermBackendProps)

Experimental.

func NewBooleanMap_Override

func NewBooleanMap_Override(b BooleanMap, terraformResource ITerraformResource, terraformAttribute *string)

Experimental.

func NewComplexComputedList_Override

func NewComplexComputedList_Override(c ComplexComputedList, terraformResource ITerraformResource, terraformAttribute *string, complexComputedListIndex *string)

Experimental.

func NewComplexObject_Override added in v0.7.0

func NewComplexObject_Override(c ComplexObject, terraformResource ITerraformResource, terraformAttribute *string, isSingleItem *bool)

Experimental.

func NewConsulBackend_Override

func NewConsulBackend_Override(c ConsulBackend, scope constructs.Construct, props *ConsulBackendProps)

Experimental.

func NewCosBackend_Override

func NewCosBackend_Override(c CosBackend, scope constructs.Construct, props *CosBackendProps)

Experimental.

func NewDataTerraformRemoteStateArtifactory_Override

func NewDataTerraformRemoteStateArtifactory_Override(d DataTerraformRemoteStateArtifactory, scope constructs.Construct, id *string, config *DataTerraformRemoteStateArtifactoryConfig)

Experimental.

func NewDataTerraformRemoteStateAzurerm_Override

func NewDataTerraformRemoteStateAzurerm_Override(d DataTerraformRemoteStateAzurerm, scope constructs.Construct, id *string, config *DataTerraformRemoteStateAzurermConfig)

Experimental.

func NewDataTerraformRemoteStateConsul_Override

func NewDataTerraformRemoteStateConsul_Override(d DataTerraformRemoteStateConsul, scope constructs.Construct, id *string, config *DataTerraformRemoteStateConsulConfig)

Experimental.

func NewDataTerraformRemoteStateCos_Override

func NewDataTerraformRemoteStateCos_Override(d DataTerraformRemoteStateCos, scope constructs.Construct, id *string, config *DataTerraformRemoteStateCosConfig)

Experimental.

func NewDataTerraformRemoteStateEtcdV3_Override

func NewDataTerraformRemoteStateEtcdV3_Override(d DataTerraformRemoteStateEtcdV3, scope constructs.Construct, id *string, config *DataTerraformRemoteStateEtcdV3Config)

Experimental.

func NewDataTerraformRemoteStateEtcd_Override

func NewDataTerraformRemoteStateEtcd_Override(d DataTerraformRemoteStateEtcd, scope constructs.Construct, id *string, config *DataTerraformRemoteStateEtcdConfig)

Experimental.

func NewDataTerraformRemoteStateGcs_Override

func NewDataTerraformRemoteStateGcs_Override(d DataTerraformRemoteStateGcs, scope constructs.Construct, id *string, config *DataTerraformRemoteStateGcsConfig)

Experimental.

func NewDataTerraformRemoteStateHttp_Override

func NewDataTerraformRemoteStateHttp_Override(d DataTerraformRemoteStateHttp, scope constructs.Construct, id *string, config *DataTerraformRemoteStateHttpConfig)

Experimental.

func NewDataTerraformRemoteStateLocal_Override

func NewDataTerraformRemoteStateLocal_Override(d DataTerraformRemoteStateLocal, scope constructs.Construct, id *string, config *DataTerraformRemoteStateLocalConfig)

Experimental.

func NewDataTerraformRemoteStateManta_Override

func NewDataTerraformRemoteStateManta_Override(d DataTerraformRemoteStateManta, scope constructs.Construct, id *string, config *DataTerraformRemoteStateMantaConfig)

Experimental.

func NewDataTerraformRemoteStateOss_Override

func NewDataTerraformRemoteStateOss_Override(d DataTerraformRemoteStateOss, scope constructs.Construct, id *string, config *DataTerraformRemoteStateOssConfig)

Experimental.

func NewDataTerraformRemoteStatePg_Override

func NewDataTerraformRemoteStatePg_Override(d DataTerraformRemoteStatePg, scope constructs.Construct, id *string, config *DataTerraformRemoteStatePgConfig)

Experimental.

func NewDataTerraformRemoteStateS3_Override

func NewDataTerraformRemoteStateS3_Override(d DataTerraformRemoteStateS3, scope constructs.Construct, id *string, config *DataTerraformRemoteStateS3Config)

Experimental.

func NewDataTerraformRemoteStateSwift_Override

func NewDataTerraformRemoteStateSwift_Override(d DataTerraformRemoteStateSwift, scope constructs.Construct, id *string, config *DataTerraformRemoteStateSwiftConfig)

Experimental.

func NewDataTerraformRemoteState_Override

func NewDataTerraformRemoteState_Override(d DataTerraformRemoteState, scope constructs.Construct, id *string, config *DataTerraformRemoteStateRemoteConfig)

Experimental.

func NewDefaultTokenResolver_Override

func NewDefaultTokenResolver_Override(d DefaultTokenResolver, concat IFragmentConcatenator)

Experimental.

func NewEtcdBackend_Override

func NewEtcdBackend_Override(e EtcdBackend, scope constructs.Construct, props *EtcdBackendProps)

Experimental.

func NewEtcdV3Backend_Override

func NewEtcdV3Backend_Override(e EtcdV3Backend, scope constructs.Construct, props *EtcdV3BackendProps)

Experimental.

func NewFn_Override added in v0.6.0

func NewFn_Override(f Fn)

Experimental.

func NewGcsBackend_Override

func NewGcsBackend_Override(g GcsBackend, scope constructs.Construct, props *GcsBackendProps)

Experimental.

func NewHttpBackend_Override

func NewHttpBackend_Override(h HttpBackend, scope constructs.Construct, props *HttpBackendProps)

Experimental.

func NewLazyBase_Override added in v0.7.0

func NewLazyBase_Override(l LazyBase)

Experimental.

func NewLazy_Override

func NewLazy_Override(l Lazy)

Experimental.

func NewLocalBackend_Override

func NewLocalBackend_Override(l LocalBackend, scope constructs.Construct, props *LocalBackendProps)

Experimental.

func NewManifest_Override

func NewManifest_Override(m Manifest, version *string, outdir *string)

Experimental.

func NewMantaBackend_Override

func NewMantaBackend_Override(m MantaBackend, scope constructs.Construct, props *MantaBackendProps)

Experimental.

func NewNamedRemoteWorkspace_Override

func NewNamedRemoteWorkspace_Override(n NamedRemoteWorkspace, name *string)

Experimental.

func NewNumberMap_Override

func NewNumberMap_Override(n NumberMap, terraformResource ITerraformResource, terraformAttribute *string)

Experimental.

func NewOssBackend_Override

func NewOssBackend_Override(o OssBackend, scope constructs.Construct, props *OssBackendProps)

Experimental.

func NewPgBackend_Override

func NewPgBackend_Override(p PgBackend, scope constructs.Construct, props *PgBackendProps)

Experimental.

func NewPrefixedRemoteWorkspaces_Override

func NewPrefixedRemoteWorkspaces_Override(p PrefixedRemoteWorkspaces, prefix *string)

Experimental.

func NewRemoteBackend_Override

func NewRemoteBackend_Override(r RemoteBackend, scope constructs.Construct, props *RemoteBackendProps)

Experimental.

func NewResource_Override

func NewResource_Override(r Resource, scope constructs.Construct, id *string)

Experimental.

func NewS3Backend_Override

func NewS3Backend_Override(s S3Backend, scope constructs.Construct, props *S3BackendProps)

Experimental.

func NewStringConcat_Override

func NewStringConcat_Override(s StringConcat)

Experimental.

func NewStringMap_Override

func NewStringMap_Override(s StringMap, terraformResource ITerraformResource, terraformAttribute *string)

Experimental.

func NewSwiftBackend_Override

func NewSwiftBackend_Override(s SwiftBackend, scope constructs.Construct, props *SwiftBackendProps)

Experimental.

func NewTerraformAsset_Override added in v0.4.0

func NewTerraformAsset_Override(t TerraformAsset, scope constructs.Construct, id *string, config *TerraformAssetConfig)

A Terraform Asset takes a file or directory outside of the CDK for Terraform context and moves it into it.

Assets copy referenced files into the stacks context for further usage in other resources. Experimental.

func NewTerraformBackend_Override

func NewTerraformBackend_Override(t TerraformBackend, scope constructs.Construct, id *string, name *string)

Experimental.

func NewTerraformDataSource_Override

func NewTerraformDataSource_Override(t TerraformDataSource, scope constructs.Construct, id *string, config *TerraformResourceConfig)

Experimental.

func NewTerraformElement_Override

func NewTerraformElement_Override(t TerraformElement, scope constructs.Construct, id *string)

Experimental.

func NewTerraformHclModule_Override

func NewTerraformHclModule_Override(t TerraformHclModule, scope constructs.Construct, id *string, options *TerraformHclModuleOptions)

Experimental.

func NewTerraformLocal_Override

func NewTerraformLocal_Override(t TerraformLocal, scope constructs.Construct, id *string, expression interface{})

Experimental.

func NewTerraformModule_Override

func NewTerraformModule_Override(t TerraformModule, scope constructs.Construct, id *string, options *TerraformModuleOptions)

Experimental.

func NewTerraformOutput_Override

func NewTerraformOutput_Override(t TerraformOutput, scope constructs.Construct, id *string, config *TerraformOutputConfig)

Experimental.

func NewTerraformProvider_Override

func NewTerraformProvider_Override(t TerraformProvider, scope constructs.Construct, id *string, config *TerraformProviderConfig)

Experimental.

func NewTerraformRemoteState_Override

func NewTerraformRemoteState_Override(t TerraformRemoteState, scope constructs.Construct, id *string, backend *string, config *DataTerraformRemoteStateConfig)

Experimental.

func NewTerraformResource_Override

func NewTerraformResource_Override(t TerraformResource, scope constructs.Construct, id *string, config *TerraformResourceConfig)

Experimental.

func NewTerraformStack_Override

func NewTerraformStack_Override(t TerraformStack, scope constructs.Construct, id *string)

Experimental.

func NewTerraformVariable_Override

func NewTerraformVariable_Override(t TerraformVariable, scope constructs.Construct, id *string, config *TerraformVariableConfig)

Experimental.

func NewToken_Override

func NewToken_Override(t Token)

Experimental.

func NewTokenization_Override

func NewTokenization_Override(t Tokenization)

Experimental.

func NewTokenizedStringFragments_Override

func NewTokenizedStringFragments_Override(t TokenizedStringFragments)

Experimental.

func NewVariableType_Override

func NewVariableType_Override(v VariableType)

Experimental.

func OssBackend_IsConstruct added in v0.6.0

func OssBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func PgBackend_IsConstruct added in v0.6.0

func PgBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func RemoteBackend_IsConstruct added in v0.6.0

func RemoteBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Resource_IsConstruct added in v0.6.0

func Resource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func S3Backend_IsConstruct added in v0.6.0

func S3Backend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func SwiftBackend_IsConstruct added in v0.6.0

func SwiftBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformAsset_IsConstruct added in v0.6.0

func TerraformAsset_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformBackend_IsConstruct added in v0.6.0

func TerraformBackend_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformDataSource_IsConstruct added in v0.6.0

func TerraformDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformElement_IsConstruct added in v0.6.0

func TerraformElement_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformHclModule_IsConstruct added in v0.6.0

func TerraformHclModule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformLocal_IsConstruct added in v0.6.0

func TerraformLocal_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformModule_IsConstruct added in v0.6.0

func TerraformModule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformOutput_IsConstruct added in v0.6.0

func TerraformOutput_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformProvider_IsConstruct added in v0.6.0

func TerraformProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformRemoteState_IsConstruct added in v0.6.0

func TerraformRemoteState_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformResource_IsConstruct added in v0.6.0

func TerraformResource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformStack_IsConstruct added in v0.6.0

func TerraformStack_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func TerraformStack_IsStack

func TerraformStack_IsStack(x interface{}) *bool

Experimental.

func TerraformVariable_IsConstruct added in v0.6.0

func TerraformVariable_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Testing_FullSynth added in v0.6.0

func Testing_FullSynth(stack TerraformStack) *string

Experimental.

func Testing_RenderConstructTree added in v0.6.0

func Testing_RenderConstructTree(construct constructs.IConstruct) *string

Experimental.

func Testing_SetupJest added in v0.6.0

func Testing_SetupJest()

Experimental.

func Testing_Synth

func Testing_Synth(stack TerraformStack) *string

Returns the Terraform synthesized JSON. Experimental.

func Testing_SynthScope added in v0.6.0

func Testing_SynthScope(fn IScopeCallback) *string

Experimental.

func Token_AsList

func Token_AsList(value interface{}, options *EncodingOptions) *[]*string

Return a reversible list representation of this token. Experimental.

func Token_AsNumber

func Token_AsNumber(value interface{}) *float64

Return a reversible number representation of this token. Experimental.

func Token_AsString

func Token_AsString(value interface{}, options *EncodingOptions) *string

Return a reversible string representation of this token.

If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.

Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling `resolve()` on the string. Experimental.

func Token_IsUnresolved

func Token_IsUnresolved(obj interface{}) *bool

Returns true if obj represents an unresolved value.

One of these must be true:

- `obj` is an IResolvable - `obj` is a string containing at least one encoded `IResolvable` - `obj` is either an encoded number or list

This does NOT recurse into lists or objects to see if they containing resolvables. Experimental.

func Tokenization_IsResolvable

func Tokenization_IsResolvable(obj interface{}) *bool

Return whether the given object is an IResolvable object.

This is different from Token.isUnresolved() which will also check for encoded Tokens, whereas this method will only do a type check on the given object. Experimental.

func Tokenization_Resolve

func Tokenization_Resolve(obj interface{}, options *ResolveOptions) interface{}

Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.

Values can only be primitives, arrays or tokens. Other objects (i.e. with methods) will be rejected. Experimental.

func Tokenization_Reverse added in v0.6.0

func Tokenization_Reverse(x interface{}) *[]IResolvable

Reverse any value into Resolvables, if possible. Experimental.

func Tokenization_StringifyNumber

func Tokenization_StringifyNumber(x *float64) *string

Stringify a number directly or lazily if it's a Token.

If it is an object (i.e., { Ref: 'SomeLogicalId' }), return it as-is. Experimental.

func VariableType_ANY

func VariableType_ANY() *string

func VariableType_BOOL

func VariableType_BOOL() *string

func VariableType_LIST

func VariableType_LIST() *string

func VariableType_LIST_BOOL

func VariableType_LIST_BOOL() *string

func VariableType_LIST_NUMBER

func VariableType_LIST_NUMBER() *string

func VariableType_LIST_STRING

func VariableType_LIST_STRING() *string

func VariableType_List

func VariableType_List(type_ *string) *string

Experimental.

func VariableType_MAP

func VariableType_MAP() *string

func VariableType_MAP_BOOL

func VariableType_MAP_BOOL() *string

func VariableType_MAP_NUMBER

func VariableType_MAP_NUMBER() *string

func VariableType_MAP_STRING

func VariableType_MAP_STRING() *string

func VariableType_Map

func VariableType_Map(type_ *string) *string

Experimental.

func VariableType_NUMBER

func VariableType_NUMBER() *string

func VariableType_Object

func VariableType_Object(attributes *map[string]*string) *string

Experimental.

func VariableType_SET

func VariableType_SET() *string

func VariableType_SET_BOOL

func VariableType_SET_BOOL() *string

func VariableType_SET_NUMBER

func VariableType_SET_NUMBER() *string

func VariableType_SET_STRING

func VariableType_SET_STRING() *string

func VariableType_STRING

func VariableType_STRING() *string

func VariableType_Set

func VariableType_Set(type_ *string) *string

Experimental.

func VariableType_Tuple

func VariableType_Tuple(elements ...*string) *string

Experimental.

Types

type AnnotationMetadataEntryType added in v0.6.0

type AnnotationMetadataEntryType string

Experimental.

const (
	AnnotationMetadataEntryType_INFO  AnnotationMetadataEntryType = "INFO"
	AnnotationMetadataEntryType_WARN  AnnotationMetadataEntryType = "WARN"
	AnnotationMetadataEntryType_ERROR AnnotationMetadataEntryType = "ERROR"
)

type Annotations added in v0.6.0

type Annotations interface {
	AddError(message *string)
	AddInfo(message *string)
	AddWarning(message *string)
}

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

func Annotations_Of added in v0.6.0

func Annotations_Of(scope constructs.IConstruct) Annotations

Returns the annotations API for a construct scope. Experimental.

type App

type App interface {
	constructs.Construct
	Manifest() Manifest
	Node() constructs.Node
	Outdir() *string
	SkipValidation() *bool
	TargetStackId() *string
	Synth()
	ToString() *string
}

Represents a cdktf application. Experimental.

func NewApp

func NewApp(options *AppOptions) App

Defines an app. Experimental.

func Testing_App

func Testing_App() App

Returns an app for testing with the following properties: - Output directory is a temp dir. Experimental.

func Testing_EnableFutureFlags

func Testing_EnableFutureFlags(app App) App

Experimental.

func Testing_StubVersion

func Testing_StubVersion(app App) App

Experimental.

type AppOptions

type AppOptions struct {
	// Additional context values for the application.
	//
	// Context set by the CLI or the `context` key in `cdktf.json` has precedence.
	//
	// Context can be read from any construct using `node.getContext(key)`.
	// Experimental.
	Context *map[string]interface{} `json:"context"`
	// The directory to output Terraform resources.
	// Experimental.
	Outdir *string `json:"outdir"`
	// Whether to skip the validation during synthesis of the app.
	// Experimental.
	SkipValidation *bool `json:"skipValidation"`
	// Experimental.
	StackTraces *bool `json:"stackTraces"`
}

Experimental.

type ArtifactoryBackend

type ArtifactoryBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewArtifactoryBackend

func NewArtifactoryBackend(scope constructs.Construct, props *ArtifactoryBackendProps) ArtifactoryBackend

Experimental.

type ArtifactoryBackendProps

type ArtifactoryBackendProps struct {
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	Repo *string `json:"repo"`
	// Experimental.
	Subpath *string `json:"subpath"`
	// Experimental.
	Url *string `json:"url"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type Aspects added in v0.6.0

type Aspects interface {
	All() *[]IAspect
	Add(aspect IAspect)
}

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

func Aspects_Of added in v0.6.0

func Aspects_Of(scope constructs.IConstruct) Aspects

Returns the `Aspects` object associated with a construct scope. Experimental.

type AssetType added in v0.4.0

type AssetType string

Experimental.

const (
	AssetType_FILE      AssetType = "FILE"
	AssetType_DIRECTORY AssetType = "DIRECTORY"
	AssetType_ARCHIVE   AssetType = "ARCHIVE"
)

type AzurermBackend

type AzurermBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewAzurermBackend

func NewAzurermBackend(scope constructs.Construct, props *AzurermBackendProps) AzurermBackend

Experimental.

type AzurermBackendProps

type AzurermBackendProps struct {
	// Experimental.
	ContainerName *string `json:"containerName"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	StorageAccountName *string `json:"storageAccountName"`
	// Experimental.
	AccessKey *string `json:"accessKey"`
	// Experimental.
	ClientId *string `json:"clientId"`
	// Experimental.
	ClientSecret *string `json:"clientSecret"`
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// Experimental.
	Environment *string `json:"environment"`
	// Experimental.
	MsiEndpoint *string `json:"msiEndpoint"`
	// Experimental.
	ResourceGroupName *string `json:"resourceGroupName"`
	// Experimental.
	SasToken *string `json:"sasToken"`
	// Experimental.
	SubscriptionId *string `json:"subscriptionId"`
	// Experimental.
	TenantId *string `json:"tenantId"`
	// Experimental.
	UseMsi *bool `json:"useMsi"`
}

Experimental.

type BooleanMap

type BooleanMap interface {
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	TerraformResource() ITerraformResource
	SetTerraformResource(val ITerraformResource)
	Lookup(key *string) *bool
}

Experimental.

func NewBooleanMap

func NewBooleanMap(terraformResource ITerraformResource, terraformAttribute *string) BooleanMap

Experimental.

type ComplexComputedList

type ComplexComputedList interface {
	ComplexComputedListIndex() *string
	SetComplexComputedListIndex(val *string)
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	TerraformResource() ITerraformResource
	SetTerraformResource(val ITerraformResource)
	GetBooleanAttribute(terraformAttribute *string) interface{}
	GetListAttribute(terraformAttribute *string) *[]*string
	GetNumberAttribute(terraformAttribute *string) *float64
	GetStringAttribute(terraformAttribute *string) *string
	InterpolationForAttribute(property *string) IResolvable
}

Experimental.

func NewComplexComputedList

func NewComplexComputedList(terraformResource ITerraformResource, terraformAttribute *string, complexComputedListIndex *string) ComplexComputedList

Experimental.

type ComplexObject added in v0.7.0

type ComplexObject interface {
	IsSingleItem() *bool
	SetIsSingleItem(val *bool)
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	TerraformResource() ITerraformResource
	SetTerraformResource(val ITerraformResource)
	GetBooleanAttribute(terraformAttribute *string) interface{}
	GetListAttribute(terraformAttribute *string) *[]*string
	GetNumberAttribute(terraformAttribute *string) *float64
	GetStringAttribute(terraformAttribute *string) *string
	InterpolationAsList() IResolvable
	InterpolationForAttribute(property *string) IResolvable
}

Experimental.

func NewComplexObject added in v0.7.0

func NewComplexObject(terraformResource ITerraformResource, terraformAttribute *string, isSingleItem *bool) ComplexObject

Experimental.

type ConsulBackend

type ConsulBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewConsulBackend

func NewConsulBackend(scope constructs.Construct, props *ConsulBackendProps) ConsulBackend

Experimental.

type ConsulBackendProps

type ConsulBackendProps struct {
	// Experimental.
	AccessToken *string `json:"accessToken"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	Address *string `json:"address"`
	// Experimental.
	CaFile *string `json:"caFile"`
	// Experimental.
	CertFile *string `json:"certFile"`
	// Experimental.
	Datacenter *string `json:"datacenter"`
	// Experimental.
	Gzip *bool `json:"gzip"`
	// Experimental.
	HttpAuth *string `json:"httpAuth"`
	// Experimental.
	KeyFile *string `json:"keyFile"`
	// Experimental.
	Lock *bool `json:"lock"`
	// Experimental.
	Scheme *string `json:"scheme"`
}

Experimental.

type CosBackend

type CosBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewCosBackend

func NewCosBackend(scope constructs.Construct, props *CosBackendProps) CosBackend

Experimental.

type CosBackendProps

type CosBackendProps struct {
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	Acl *string `json:"acl"`
	// Experimental.
	Encrypt *bool `json:"encrypt"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	Prefix *string `json:"prefix"`
	// Experimental.
	Region *string `json:"region"`
	// Experimental.
	SecretId *string `json:"secretId"`
	// Experimental.
	SecretKey *string `json:"secretKey"`
}

Experimental.

type DataTerraformRemoteState

type DataTerraformRemoteState interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteState

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

Experimental.

type DataTerraformRemoteStateArtifactory

type DataTerraformRemoteStateArtifactory interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateArtifactory

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

Experimental.

type DataTerraformRemoteStateArtifactoryConfig

type DataTerraformRemoteStateArtifactoryConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	Repo *string `json:"repo"`
	// Experimental.
	Subpath *string `json:"subpath"`
	// Experimental.
	Url *string `json:"url"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type DataTerraformRemoteStateAzurerm

type DataTerraformRemoteStateAzurerm interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateAzurerm

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

Experimental.

type DataTerraformRemoteStateAzurermConfig

type DataTerraformRemoteStateAzurermConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	ContainerName *string `json:"containerName"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	StorageAccountName *string `json:"storageAccountName"`
	// Experimental.
	AccessKey *string `json:"accessKey"`
	// Experimental.
	ClientId *string `json:"clientId"`
	// Experimental.
	ClientSecret *string `json:"clientSecret"`
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// Experimental.
	Environment *string `json:"environment"`
	// Experimental.
	MsiEndpoint *string `json:"msiEndpoint"`
	// Experimental.
	ResourceGroupName *string `json:"resourceGroupName"`
	// Experimental.
	SasToken *string `json:"sasToken"`
	// Experimental.
	SubscriptionId *string `json:"subscriptionId"`
	// Experimental.
	TenantId *string `json:"tenantId"`
	// Experimental.
	UseMsi *bool `json:"useMsi"`
}

Experimental.

type DataTerraformRemoteStateConfig

type DataTerraformRemoteStateConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
}

Experimental.

type DataTerraformRemoteStateConsul

type DataTerraformRemoteStateConsul interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateConsul

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

Experimental.

type DataTerraformRemoteStateConsulConfig

type DataTerraformRemoteStateConsulConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	AccessToken *string `json:"accessToken"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	Address *string `json:"address"`
	// Experimental.
	CaFile *string `json:"caFile"`
	// Experimental.
	CertFile *string `json:"certFile"`
	// Experimental.
	Datacenter *string `json:"datacenter"`
	// Experimental.
	Gzip *bool `json:"gzip"`
	// Experimental.
	HttpAuth *string `json:"httpAuth"`
	// Experimental.
	KeyFile *string `json:"keyFile"`
	// Experimental.
	Lock *bool `json:"lock"`
	// Experimental.
	Scheme *string `json:"scheme"`
}

Experimental.

type DataTerraformRemoteStateCos

type DataTerraformRemoteStateCos interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateCos

func NewDataTerraformRemoteStateCos(scope constructs.Construct, id *string, config *DataTerraformRemoteStateCosConfig) DataTerraformRemoteStateCos

Experimental.

type DataTerraformRemoteStateCosConfig

type DataTerraformRemoteStateCosConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	Acl *string `json:"acl"`
	// Experimental.
	Encrypt *bool `json:"encrypt"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	Prefix *string `json:"prefix"`
	// Experimental.
	Region *string `json:"region"`
	// Experimental.
	SecretId *string `json:"secretId"`
	// Experimental.
	SecretKey *string `json:"secretKey"`
}

Experimental.

type DataTerraformRemoteStateEtcd

type DataTerraformRemoteStateEtcd interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateEtcd

func NewDataTerraformRemoteStateEtcd(scope constructs.Construct, id *string, config *DataTerraformRemoteStateEtcdConfig) DataTerraformRemoteStateEtcd

Experimental.

type DataTerraformRemoteStateEtcdConfig

type DataTerraformRemoteStateEtcdConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Endpoints *string `json:"endpoints"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type DataTerraformRemoteStateEtcdV3

type DataTerraformRemoteStateEtcdV3 interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateEtcdV3

func NewDataTerraformRemoteStateEtcdV3(scope constructs.Construct, id *string, config *DataTerraformRemoteStateEtcdV3Config) DataTerraformRemoteStateEtcdV3

Experimental.

type DataTerraformRemoteStateEtcdV3Config

type DataTerraformRemoteStateEtcdV3Config struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Endpoints *[]*string `json:"endpoints"`
	// Experimental.
	CacertPath *string `json:"cacertPath"`
	// Experimental.
	CertPath *string `json:"certPath"`
	// Experimental.
	KeyPath *string `json:"keyPath"`
	// Experimental.
	Lock *bool `json:"lock"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	Prefix *string `json:"prefix"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type DataTerraformRemoteStateGcs

type DataTerraformRemoteStateGcs interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateGcs

func NewDataTerraformRemoteStateGcs(scope constructs.Construct, id *string, config *DataTerraformRemoteStateGcsConfig) DataTerraformRemoteStateGcs

Experimental.

type DataTerraformRemoteStateGcsConfig

type DataTerraformRemoteStateGcsConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	AccessToken *string `json:"accessToken"`
	// Experimental.
	Credentials *string `json:"credentials"`
	// Experimental.
	EncryptionKey *string `json:"encryptionKey"`
	// Experimental.
	Prefix *string `json:"prefix"`
}

Experimental.

type DataTerraformRemoteStateHttp

type DataTerraformRemoteStateHttp interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateHttp

func NewDataTerraformRemoteStateHttp(scope constructs.Construct, id *string, config *DataTerraformRemoteStateHttpConfig) DataTerraformRemoteStateHttp

Experimental.

type DataTerraformRemoteStateHttpConfig

type DataTerraformRemoteStateHttpConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Address *string `json:"address"`
	// Experimental.
	LockAddress *string `json:"lockAddress"`
	// Experimental.
	LockMethod *string `json:"lockMethod"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	RetryMax *float64 `json:"retryMax"`
	// Experimental.
	RetryWaitMax *float64 `json:"retryWaitMax"`
	// Experimental.
	RetryWaitMin *float64 `json:"retryWaitMin"`
	// Experimental.
	SkipCertVerification *bool `json:"skipCertVerification"`
	// Experimental.
	UnlockAddress *string `json:"unlockAddress"`
	// Experimental.
	UnlockMethod *string `json:"unlockMethod"`
	// Experimental.
	UpdateMethod *string `json:"updateMethod"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type DataTerraformRemoteStateLocal

type DataTerraformRemoteStateLocal interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateLocal

func NewDataTerraformRemoteStateLocal(scope constructs.Construct, id *string, config *DataTerraformRemoteStateLocalConfig) DataTerraformRemoteStateLocal

Experimental.

type DataTerraformRemoteStateLocalConfig

type DataTerraformRemoteStateLocalConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	WorkspaceDir *string `json:"workspaceDir"`
}

Experimental.

type DataTerraformRemoteStateManta

type DataTerraformRemoteStateManta interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateManta

func NewDataTerraformRemoteStateManta(scope constructs.Construct, id *string, config *DataTerraformRemoteStateMantaConfig) DataTerraformRemoteStateManta

Experimental.

type DataTerraformRemoteStateMantaConfig

type DataTerraformRemoteStateMantaConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Account *string `json:"account"`
	// Experimental.
	KeyId *string `json:"keyId"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	InsecureSkipTlsVerify *bool `json:"insecureSkipTlsVerify"`
	// Experimental.
	KeyMaterial *string `json:"keyMaterial"`
	// Experimental.
	ObjectName *string `json:"objectName"`
	// Experimental.
	Url *string `json:"url"`
	// Experimental.
	User *string `json:"user"`
}

Experimental.

type DataTerraformRemoteStateOss

type DataTerraformRemoteStateOss interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateOss

func NewDataTerraformRemoteStateOss(scope constructs.Construct, id *string, config *DataTerraformRemoteStateOssConfig) DataTerraformRemoteStateOss

Experimental.

type DataTerraformRemoteStateOssConfig

type DataTerraformRemoteStateOssConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	AccessKey *string `json:"accessKey"`
	// Experimental.
	Acl *string `json:"acl"`
	// Experimental.
	AssumeRole *OssAssumeRole `json:"assumeRole"`
	// Experimental.
	EcsRoleName *string `json:"ecsRoleName"`
	// Experimental.
	Encrypt *bool `json:"encrypt"`
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	Prefix *string `json:"prefix"`
	// Experimental.
	Profile *string `json:"profile"`
	// Experimental.
	Region *string `json:"region"`
	// Experimental.
	SecretKey *string `json:"secretKey"`
	// Experimental.
	SecurityToken *string `json:"securityToken"`
	// Experimental.
	SharedCredentialsFile *string `json:"sharedCredentialsFile"`
	// Experimental.
	TablestoreEndpoint *string `json:"tablestoreEndpoint"`
	// Experimental.
	TablestoreTable *string `json:"tablestoreTable"`
}

Experimental.

type DataTerraformRemoteStatePg

type DataTerraformRemoteStatePg interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStatePg

func NewDataTerraformRemoteStatePg(scope constructs.Construct, id *string, config *DataTerraformRemoteStatePgConfig) DataTerraformRemoteStatePg

Experimental.

type DataTerraformRemoteStatePgConfig

type DataTerraformRemoteStatePgConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	ConnStr *string `json:"connStr"`
	// Experimental.
	SchemaName *string `json:"schemaName"`
	// Experimental.
	SkipSchemaCreation *bool `json:"skipSchemaCreation"`
}

Experimental.

type DataTerraformRemoteStateRemoteConfig

type DataTerraformRemoteStateRemoteConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Organization *string `json:"organization"`
	// Experimental.
	Workspaces IRemoteWorkspace `json:"workspaces"`
	// Experimental.
	Hostname *string `json:"hostname"`
	// Experimental.
	Token *string `json:"token"`
}

Experimental.

type DataTerraformRemoteStateS3

type DataTerraformRemoteStateS3 interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateS3

func NewDataTerraformRemoteStateS3(scope constructs.Construct, id *string, config *DataTerraformRemoteStateS3Config) DataTerraformRemoteStateS3

Experimental.

type DataTerraformRemoteStateS3Config

type DataTerraformRemoteStateS3Config struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	AccessKey *string `json:"accessKey"`
	// Experimental.
	Acl *string `json:"acl"`
	// Experimental.
	AssumeRolePolicy *string `json:"assumeRolePolicy"`
	// Experimental.
	DynamodbEndpoint *string `json:"dynamodbEndpoint"`
	// Experimental.
	DynamodbTable *string `json:"dynamodbTable"`
	// Experimental.
	Encrypt *bool `json:"encrypt"`
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// Experimental.
	ExternalId *string `json:"externalId"`
	// Experimental.
	ForcePathStyle *bool `json:"forcePathStyle"`
	// Experimental.
	IamEndpoint *string `json:"iamEndpoint"`
	// Experimental.
	KmsKeyId *string `json:"kmsKeyId"`
	// Experimental.
	MaxRetries *float64 `json:"maxRetries"`
	// Experimental.
	Profile *string `json:"profile"`
	// Experimental.
	Region *string `json:"region"`
	// Experimental.
	RoleArn *string `json:"roleArn"`
	// Experimental.
	SecretKey *string `json:"secretKey"`
	// Experimental.
	SessionName *string `json:"sessionName"`
	// Experimental.
	SharedCredentialsFile *string `json:"sharedCredentialsFile"`
	// Experimental.
	SkipCredentialsValidation *bool `json:"skipCredentialsValidation"`
	// Experimental.
	SkipMetadataApiCheck *bool `json:"skipMetadataApiCheck"`
	// Experimental.
	SseCustomerKey *string `json:"sseCustomerKey"`
	// Experimental.
	StsEndpoint *string `json:"stsEndpoint"`
	// Experimental.
	Token *string `json:"token"`
	// Experimental.
	WorkspaceKeyPrefix *string `json:"workspaceKeyPrefix"`
}

Experimental.

type DataTerraformRemoteStateSwift

type DataTerraformRemoteStateSwift interface {
	TerraformRemoteState
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewDataTerraformRemoteStateSwift

func NewDataTerraformRemoteStateSwift(scope constructs.Construct, id *string, config *DataTerraformRemoteStateSwiftConfig) DataTerraformRemoteStateSwift

Experimental.

type DataTerraformRemoteStateSwiftConfig

type DataTerraformRemoteStateSwiftConfig struct {
	// Experimental.
	Defaults *map[string]interface{} `json:"defaults"`
	// Experimental.
	Workspace *string `json:"workspace"`
	// Experimental.
	Container *string `json:"container"`
	// Experimental.
	ApplicationCredentialId *string `json:"applicationCredentialId"`
	// Experimental.
	ApplicationCredentialName *string `json:"applicationCredentialName"`
	// Experimental.
	ApplicationCredentialSecret *string `json:"applicationCredentialSecret"`
	// Experimental.
	ArchiveContainer *string `json:"archiveContainer"`
	// Experimental.
	AuthUrl *string `json:"authUrl"`
	// Experimental.
	CacertFile *string `json:"cacertFile"`
	// Experimental.
	Cert *string `json:"cert"`
	// Experimental.
	Cloud *string `json:"cloud"`
	// Experimental.
	DefaultDomain *string `json:"defaultDomain"`
	// Experimental.
	DomainId *string `json:"domainId"`
	// Experimental.
	DomainName *string `json:"domainName"`
	// Experimental.
	ExpireAfter *string `json:"expireAfter"`
	// Experimental.
	Insecure *bool `json:"insecure"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	ProjectDomainId *string `json:"projectDomainId"`
	// Experimental.
	ProjectDomainName *string `json:"projectDomainName"`
	// Experimental.
	RegionName *string `json:"regionName"`
	// Experimental.
	StateName *string `json:"stateName"`
	// Experimental.
	TenantId *string `json:"tenantId"`
	// Experimental.
	TenantName *string `json:"tenantName"`
	// Experimental.
	Token *string `json:"token"`
	// Experimental.
	UserDomainId *string `json:"userDomainId"`
	// Experimental.
	UserDomainName *string `json:"userDomainName"`
	// Experimental.
	UserId *string `json:"userId"`
	// Experimental.
	UserName *string `json:"userName"`
}

Experimental.

type DefaultTokenResolver

type DefaultTokenResolver interface {
	ITokenResolver
	ResolveList(xs *[]*string, context IResolveContext) interface{}
	ResolveString(fragments TokenizedStringFragments, context IResolveContext) interface{}
	ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}
}

Default resolver implementation. Experimental.

func NewDefaultTokenResolver

func NewDefaultTokenResolver(concat IFragmentConcatenator) DefaultTokenResolver

Experimental.

type EncodingOptions

type EncodingOptions struct {
	// A hint for the Token's purpose when stringifying it.
	// Experimental.
	DisplayHint *string `json:"displayHint"`
}

Properties to string encodings. Experimental.

type EtcdBackend

type EtcdBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewEtcdBackend

func NewEtcdBackend(scope constructs.Construct, props *EtcdBackendProps) EtcdBackend

Experimental.

type EtcdBackendProps

type EtcdBackendProps struct {
	// Experimental.
	Endpoints *string `json:"endpoints"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type EtcdV3Backend

type EtcdV3Backend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewEtcdV3Backend

func NewEtcdV3Backend(scope constructs.Construct, props *EtcdV3BackendProps) EtcdV3Backend

Experimental.

type EtcdV3BackendProps

type EtcdV3BackendProps struct {
	// Experimental.
	Endpoints *[]*string `json:"endpoints"`
	// Experimental.
	CacertPath *string `json:"cacertPath"`
	// Experimental.
	CertPath *string `json:"certPath"`
	// Experimental.
	KeyPath *string `json:"keyPath"`
	// Experimental.
	Lock *bool `json:"lock"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	Prefix *string `json:"prefix"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type Fn added in v0.6.0

type Fn interface {
}

Experimental.

func NewFn added in v0.6.0

func NewFn() Fn

Experimental.

type GcsBackend

type GcsBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewGcsBackend

func NewGcsBackend(scope constructs.Construct, props *GcsBackendProps) GcsBackend

Experimental.

type GcsBackendProps

type GcsBackendProps struct {
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	AccessToken *string `json:"accessToken"`
	// Experimental.
	Credentials *string `json:"credentials"`
	// Experimental.
	EncryptionKey *string `json:"encryptionKey"`
	// Experimental.
	Prefix *string `json:"prefix"`
}

Experimental.

type HttpBackend

type HttpBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewHttpBackend

func NewHttpBackend(scope constructs.Construct, props *HttpBackendProps) HttpBackend

Experimental.

type HttpBackendProps

type HttpBackendProps struct {
	// Experimental.
	Address *string `json:"address"`
	// Experimental.
	LockAddress *string `json:"lockAddress"`
	// Experimental.
	LockMethod *string `json:"lockMethod"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	RetryMax *float64 `json:"retryMax"`
	// Experimental.
	RetryWaitMax *float64 `json:"retryWaitMax"`
	// Experimental.
	RetryWaitMin *float64 `json:"retryWaitMin"`
	// Experimental.
	SkipCertVerification *bool `json:"skipCertVerification"`
	// Experimental.
	UnlockAddress *string `json:"unlockAddress"`
	// Experimental.
	UnlockMethod *string `json:"unlockMethod"`
	// Experimental.
	UpdateMethod *string `json:"updateMethod"`
	// Experimental.
	Username *string `json:"username"`
}

Experimental.

type IAnyProducer

type IAnyProducer interface {
	// Produce the value.
	// Experimental.
	Produce(context IResolveContext) interface{}
}

Interface for lazy untyped value producers. Experimental.

type IAspect added in v0.6.0

type IAspect interface {
	// All aspects can visit an IConstruct.
	// Experimental.
	Visit(node constructs.IConstruct)
}

Represents an Aspect. Experimental.

type IFragmentConcatenator

type IFragmentConcatenator interface {
	// Join the fragment on the left and on the right.
	// Experimental.
	Join(left interface{}, right interface{}) interface{}
}

Function used to concatenate symbols in the target document language.

Interface so it could potentially be exposed over jsii. Experimental.

type IListProducer

type IListProducer interface {
	// Produce the list value.
	// Experimental.
	Produce(context IResolveContext) *[]*string
}

Interface for lazy list producers. Experimental.

type IManifest added in v0.6.0

type IManifest interface {
	// Experimental.
	Stacks() *map[string]*StackManifest
	// Experimental.
	Version() *string
}

Experimental.

type INumberProducer

type INumberProducer interface {
	// Produce the number value.
	// Experimental.
	Produce(context IResolveContext) *float64
}

Interface for lazy number producers. Experimental.

type IPostProcessor

type IPostProcessor interface {
	// Process the completely resolved value, after full recursion/resolution has happened.
	// Experimental.
	PostProcess(input interface{}, context IResolveContext) interface{}
}

A Token that can post-process the complete resolved value, after resolve() has recursed over it. Experimental.

type IRemoteWorkspace

type IRemoteWorkspace interface {
}

Experimental.

type IResolvable

type IResolvable interface {
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(context IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *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.
	// Experimental.
	CreationStack() *[]*string
}

Interface for values that can be resolvable later.

Tokens are special objects that participate in synthesis. Experimental.

func Fn_Alltrue added in v0.6.0

func Fn_Alltrue(values *[]interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/anytrue.html anytrue} returns true if all elements in a given collection are true or "true". Experimental.

func Fn_Anytrue added in v0.6.0

func Fn_Anytrue(value *[]interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/anytrue.html anytrue} returns true if any element in a given collection is true or "true". Experimental.

func Fn_Can added in v0.6.0

func Fn_Can(expression interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/can.html can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors. Experimental.

func Fn_Coalesce added in v0.6.0

func Fn_Coalesce(value *[]interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/coalesce.html coalesce} takes any number of arguments and returns the first one that isn't null or an empty string. Experimental.

func Fn_Contains added in v0.6.0

func Fn_Contains(list *[]interface{}, value interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/contains.html contains} determines whether a given list or set contains a given single value as one of its elements. Experimental.

func Fn_Fileexists added in v0.6.0

func Fn_Fileexists(value interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/fileexists.html fileexists} determines whether a file exists at a given path. Experimental.

func Fn_Tobool added in v0.6.0

func Fn_Tobool(expression interface{}) IResolvable

{@link https://www.terraform.io/docs/language/functions/tobool.html tobool} converts its argument to a boolean value. Experimental.

func Lazy_AnyValue

func Lazy_AnyValue(producer IAnyProducer, options *LazyAnyValueOptions) IResolvable

Produces a lazy token from an untyped value. Experimental.

func Token_AsAny

func Token_AsAny(value interface{}) IResolvable

Return a resolvable representation of the given value. Experimental.

func Tokenization_ReverseList

func Tokenization_ReverseList(l *[]*string) IResolvable

Un-encode a Tokenized value from a list. Experimental.

func Tokenization_ReverseNumber

func Tokenization_ReverseNumber(n *float64) IResolvable

Un-encode a Tokenized value from a number. Experimental.

type IResolveContext

type IResolveContext interface {
	// Use this postprocessor after the entire token structure has been resolved.
	// Experimental.
	RegisterPostProcessor(postProcessor IPostProcessor)
	// Resolve an inner object.
	// Experimental.
	Resolve(x interface{}) interface{}
	// True when we are still preparing, false if we're rendering the final output.
	// Experimental.
	Preparing() *bool
	// The scope from which resolution has been initiated.
	// Experimental.
	Scope() constructs.IConstruct
}

Current resolution context for tokens. Experimental.

type IResource

type IResource interface {
	constructs.IConstruct
	// The stack in which this resource is defined.
	// Experimental.
	Stack() TerraformStack
}

Experimental.

type IResourceConstructor added in v0.6.0

type IResourceConstructor interface {
}

Experimental.

type IScopeCallback added in v0.6.0

type IScopeCallback interface {
}

Experimental.

type IStackSynthesizer added in v0.6.0

type IStackSynthesizer interface {
	// Synthesize the associated stack to the session.
	// Experimental.
	Synthesize(session ISynthesisSession)
}

Encodes information how a certain Stack should be deployed inspired by AWS CDK v2 implementation (synth functionality was removed in constructs v10). Experimental.

type IStringProducer

type IStringProducer interface {
	// Produce the string value.
	// Experimental.
	Produce(context IResolveContext) *string
}

Interface for lazy string producers. Experimental.

type ISynthesisSession added in v0.6.0

type ISynthesisSession interface {
	// Experimental.
	Manifest() Manifest
	// The output directory for this synthesis session.
	// Experimental.
	Outdir() *string
	// Experimental.
	SkipValidation() *bool
}

Represents a single session of synthesis.

Passed into `TerraformStack.onSynthesize()` methods. originally from aws/constructs lib v3.3.126 (synth functionality was removed in constructs v10) Experimental.

type ITerraformAddressable added in v0.8.0

type ITerraformAddressable interface {
	// Experimental.
	Fqn() *string
}

Experimental.

type ITerraformDependable

type ITerraformDependable interface {
	ITerraformAddressable
}

Experimental.

type ITerraformResource

type ITerraformResource interface {
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) IResolvable
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(c interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(d *[]*string)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	// Experimental.
	Lifecycle() *TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(l *TerraformResourceLifecycle)
	// Experimental.
	Provider() TerraformProvider
	// Experimental.
	SetProvider(p TerraformProvider)
	// Experimental.
	TerraformResourceType() *string
}

Experimental.

type ITokenMapper

type ITokenMapper interface {
	// Replace a single token.
	// Experimental.
	MapToken(t IResolvable) interface{}
}

Interface to apply operation to tokens in a string.

Interface so it can be exported via jsii. Experimental.

type ITokenResolver

type ITokenResolver interface {
	// Resolve a tokenized list.
	// Experimental.
	ResolveList(l *[]*string, context IResolveContext) interface{}
	// Resolve a string with at least one stringified token in it.
	//
	// (May use concatenation)
	// Experimental.
	ResolveString(s TokenizedStringFragments, context IResolveContext) interface{}
	// Resolve a single token.
	// Experimental.
	ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}
}

How to resolve tokens. Experimental.

type Lazy

type Lazy interface {
}

Lazily produce a value.

Can be used to return a string, list or numeric value whose actual value will only be calculated later, during synthesis. Experimental.

func NewLazy

func NewLazy() Lazy

Experimental.

type LazyAnyValueOptions

type LazyAnyValueOptions struct {
	// Use the given name as a display hint.
	// Experimental.
	DisplayHint *string `json:"displayHint"`
	// If the produced value is an array and it is empty, return 'undefined' instead.
	// Experimental.
	OmitEmptyArray *bool `json:"omitEmptyArray"`
}

Options for creating lazy untyped tokens. Experimental.

type LazyBase added in v0.7.0

type LazyBase interface {
	IResolvable
	CreationStack() *[]*string
	AddPostProcessor(postProcessor IPostProcessor)
	Resolve(context IResolveContext) interface{}
	ResolveLazy(context IResolveContext) interface{}
	ToJSON() interface{}
	ToString() *string
}

Experimental.

type LazyListValueOptions

type LazyListValueOptions struct {
	// Use the given name as a display hint.
	// Experimental.
	DisplayHint *string `json:"displayHint"`
	// If the produced list is empty, return 'undefined' instead.
	// Experimental.
	OmitEmpty *bool `json:"omitEmpty"`
}

Options for creating a lazy list token. Experimental.

type LazyStringValueOptions

type LazyStringValueOptions struct {
	// Use the given name as a display hint.
	// Experimental.
	DisplayHint *string `json:"displayHint"`
}

Options for creating a lazy string token. Experimental.

type LocalBackend

type LocalBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewLocalBackend

func NewLocalBackend(scope constructs.Construct, props *LocalBackendProps) LocalBackend

Experimental.

type LocalBackendProps

type LocalBackendProps struct {
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	WorkspaceDir *string `json:"workspaceDir"`
}

Experimental.

type Manifest

type Manifest interface {
	IManifest
	Outdir() *string
	Stacks() *map[string]*StackManifest
	Version() *string
	BuildManifest() IManifest
	ForStack(stack TerraformStack) *StackManifest
	WriteToFile()
}

Experimental.

func NewManifest

func NewManifest(version *string, outdir *string) Manifest

Experimental.

type MantaBackend

type MantaBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewMantaBackend

func NewMantaBackend(scope constructs.Construct, props *MantaBackendProps) MantaBackend

Experimental.

type MantaBackendProps

type MantaBackendProps struct {
	// Experimental.
	Account *string `json:"account"`
	// Experimental.
	KeyId *string `json:"keyId"`
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	InsecureSkipTlsVerify *bool `json:"insecureSkipTlsVerify"`
	// Experimental.
	KeyMaterial *string `json:"keyMaterial"`
	// Experimental.
	ObjectName *string `json:"objectName"`
	// Experimental.
	Url *string `json:"url"`
	// Experimental.
	User *string `json:"user"`
}

Experimental.

type NamedRemoteWorkspace

type NamedRemoteWorkspace interface {
	IRemoteWorkspace
	Name() *string
	SetName(val *string)
}

Experimental.

func NewNamedRemoteWorkspace

func NewNamedRemoteWorkspace(name *string) NamedRemoteWorkspace

Experimental.

type NumberMap

type NumberMap interface {
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	TerraformResource() ITerraformResource
	SetTerraformResource(val ITerraformResource)
	Lookup(key *string) *float64
}

Experimental.

func NewNumberMap

func NewNumberMap(terraformResource ITerraformResource, terraformAttribute *string) NumberMap

Experimental.

type OssAssumeRole

type OssAssumeRole struct {
	// Experimental.
	RoleArn *string `json:"roleArn"`
	// Experimental.
	Policy *string `json:"policy"`
	// Experimental.
	SessionExpiration *float64 `json:"sessionExpiration"`
	// Experimental.
	SessionName *string `json:"sessionName"`
}

Experimental.

type OssBackend

type OssBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewOssBackend

func NewOssBackend(scope constructs.Construct, props *OssBackendProps) OssBackend

Experimental.

type OssBackendProps

type OssBackendProps struct {
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	AccessKey *string `json:"accessKey"`
	// Experimental.
	Acl *string `json:"acl"`
	// Experimental.
	AssumeRole *OssAssumeRole `json:"assumeRole"`
	// Experimental.
	EcsRoleName *string `json:"ecsRoleName"`
	// Experimental.
	Encrypt *bool `json:"encrypt"`
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	Prefix *string `json:"prefix"`
	// Experimental.
	Profile *string `json:"profile"`
	// Experimental.
	Region *string `json:"region"`
	// Experimental.
	SecretKey *string `json:"secretKey"`
	// Experimental.
	SecurityToken *string `json:"securityToken"`
	// Experimental.
	SharedCredentialsFile *string `json:"sharedCredentialsFile"`
	// Experimental.
	TablestoreEndpoint *string `json:"tablestoreEndpoint"`
	// Experimental.
	TablestoreTable *string `json:"tablestoreTable"`
}

Experimental.

type PgBackend

type PgBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewPgBackend

func NewPgBackend(scope constructs.Construct, props *PgBackendProps) PgBackend

Experimental.

type PgBackendProps

type PgBackendProps struct {
	// Experimental.
	ConnStr *string `json:"connStr"`
	// Experimental.
	SchemaName *string `json:"schemaName"`
	// Experimental.
	SkipSchemaCreation *bool `json:"skipSchemaCreation"`
}

Experimental.

type PrefixedRemoteWorkspaces

type PrefixedRemoteWorkspaces interface {
	IRemoteWorkspace
	Prefix() *string
	SetPrefix(val *string)
}

Experimental.

func NewPrefixedRemoteWorkspaces

func NewPrefixedRemoteWorkspaces(prefix *string) PrefixedRemoteWorkspaces

Experimental.

type RemoteBackend

type RemoteBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewRemoteBackend

func NewRemoteBackend(scope constructs.Construct, props *RemoteBackendProps) RemoteBackend

Experimental.

type RemoteBackendProps

type RemoteBackendProps struct {
	// Experimental.
	Organization *string `json:"organization"`
	// Experimental.
	Workspaces IRemoteWorkspace `json:"workspaces"`
	// Experimental.
	Hostname *string `json:"hostname"`
	// Experimental.
	Token *string `json:"token"`
}

Experimental.

type ResolveOptions

type ResolveOptions struct {
	// The resolver to apply to any resolvable tokens found.
	// Experimental.
	Resolver ITokenResolver `json:"resolver"`
	// The scope from which resolution is performed.
	// Experimental.
	Scope constructs.IConstruct `json:"scope"`
	// Whether the resolution is being executed during the prepare phase or not.
	// Experimental.
	Preparing *bool `json:"preparing"`
}

Options to the resolve() operation.

NOT the same as the ResolveContext; ResolveContext is exposed to Token implementors and resolution hooks, whereas this struct is just to bundle a number of things that would otherwise be arguments to resolve() in a readable way. Experimental.

type Resource

type Resource interface {
	constructs.Construct
	IResource
	Node() constructs.Node
	Stack() TerraformStack
	ToString() *string
}

A construct which represents a resource. Experimental.

type S3Backend

type S3Backend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewS3Backend

func NewS3Backend(scope constructs.Construct, props *S3BackendProps) S3Backend

Experimental.

type S3BackendProps

type S3BackendProps struct {
	// Experimental.
	Bucket *string `json:"bucket"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	AccessKey *string `json:"accessKey"`
	// Experimental.
	Acl *string `json:"acl"`
	// Experimental.
	AssumeRolePolicy *string `json:"assumeRolePolicy"`
	// Experimental.
	DynamodbEndpoint *string `json:"dynamodbEndpoint"`
	// Experimental.
	DynamodbTable *string `json:"dynamodbTable"`
	// Experimental.
	Encrypt *bool `json:"encrypt"`
	// Experimental.
	Endpoint *string `json:"endpoint"`
	// Experimental.
	ExternalId *string `json:"externalId"`
	// Experimental.
	ForcePathStyle *bool `json:"forcePathStyle"`
	// Experimental.
	IamEndpoint *string `json:"iamEndpoint"`
	// Experimental.
	KmsKeyId *string `json:"kmsKeyId"`
	// Experimental.
	MaxRetries *float64 `json:"maxRetries"`
	// Experimental.
	Profile *string `json:"profile"`
	// Experimental.
	Region *string `json:"region"`
	// Experimental.
	RoleArn *string `json:"roleArn"`
	// Experimental.
	SecretKey *string `json:"secretKey"`
	// Experimental.
	SessionName *string `json:"sessionName"`
	// Experimental.
	SharedCredentialsFile *string `json:"sharedCredentialsFile"`
	// Experimental.
	SkipCredentialsValidation *bool `json:"skipCredentialsValidation"`
	// Experimental.
	SkipMetadataApiCheck *bool `json:"skipMetadataApiCheck"`
	// Experimental.
	SseCustomerKey *string `json:"sseCustomerKey"`
	// Experimental.
	StsEndpoint *string `json:"stsEndpoint"`
	// Experimental.
	Token *string `json:"token"`
	// Experimental.
	WorkspaceKeyPrefix *string `json:"workspaceKeyPrefix"`
}

Experimental.

type StackAnnotation added in v0.6.0

type StackAnnotation struct {
	// Experimental.
	ConstructPath *string `json:"constructPath"`
	// Experimental.
	Level AnnotationMetadataEntryType `json:"level"`
	// Experimental.
	Message *string `json:"message"`
	// Experimental.
	Stacktrace *[]*string `json:"stacktrace"`
}

Experimental.

type StackManifest

type StackManifest struct {
	// Experimental.
	Annotations *[]*StackAnnotation `json:"annotations"`
	// Experimental.
	ConstructPath *string `json:"constructPath"`
	// Experimental.
	Name *string `json:"name"`
	// Experimental.
	SynthesizedStackPath *string `json:"synthesizedStackPath"`
	// Experimental.
	WorkingDirectory *string `json:"workingDirectory"`
}

Experimental.

type StringConcat

type StringConcat interface {
	IFragmentConcatenator
	Join(left interface{}, right interface{}) interface{}
}

Converts all fragments to strings and concats those.

Drops 'undefined's. Experimental.

func NewStringConcat

func NewStringConcat() StringConcat

Experimental.

type StringMap

type StringMap interface {
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	TerraformResource() ITerraformResource
	SetTerraformResource(val ITerraformResource)
	Lookup(key *string) *string
}

Experimental.

func NewStringMap

func NewStringMap(terraformResource ITerraformResource, terraformAttribute *string) StringMap

Experimental.

type SwiftBackend

type SwiftBackend interface {
	TerraformBackend
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewSwiftBackend

func NewSwiftBackend(scope constructs.Construct, props *SwiftBackendProps) SwiftBackend

Experimental.

type SwiftBackendProps

type SwiftBackendProps struct {
	// Experimental.
	Container *string `json:"container"`
	// Experimental.
	ApplicationCredentialId *string `json:"applicationCredentialId"`
	// Experimental.
	ApplicationCredentialName *string `json:"applicationCredentialName"`
	// Experimental.
	ApplicationCredentialSecret *string `json:"applicationCredentialSecret"`
	// Experimental.
	ArchiveContainer *string `json:"archiveContainer"`
	// Experimental.
	AuthUrl *string `json:"authUrl"`
	// Experimental.
	CacertFile *string `json:"cacertFile"`
	// Experimental.
	Cert *string `json:"cert"`
	// Experimental.
	Cloud *string `json:"cloud"`
	// Experimental.
	DefaultDomain *string `json:"defaultDomain"`
	// Experimental.
	DomainId *string `json:"domainId"`
	// Experimental.
	DomainName *string `json:"domainName"`
	// Experimental.
	ExpireAfter *string `json:"expireAfter"`
	// Experimental.
	Insecure *bool `json:"insecure"`
	// Experimental.
	Key *string `json:"key"`
	// Experimental.
	Password *string `json:"password"`
	// Experimental.
	ProjectDomainId *string `json:"projectDomainId"`
	// Experimental.
	ProjectDomainName *string `json:"projectDomainName"`
	// Experimental.
	RegionName *string `json:"regionName"`
	// Experimental.
	StateName *string `json:"stateName"`
	// Experimental.
	TenantId *string `json:"tenantId"`
	// Experimental.
	TenantName *string `json:"tenantName"`
	// Experimental.
	Token *string `json:"token"`
	// Experimental.
	UserDomainId *string `json:"userDomainId"`
	// Experimental.
	UserDomainName *string `json:"userDomainName"`
	// Experimental.
	UserId *string `json:"userId"`
	// Experimental.
	UserName *string `json:"userName"`
}

Experimental.

type TerraformAsset added in v0.4.0

type TerraformAsset interface {
	Resource
	AssetHash() *string
	SetAssetHash(val *string)
	FileName() *string
	Node() constructs.Node
	Path() *string
	Stack() TerraformStack
	Type() AssetType
	SetType(val AssetType)
	ToString() *string
}

Experimental.

func NewTerraformAsset added in v0.4.0

func NewTerraformAsset(scope constructs.Construct, id *string, config *TerraformAssetConfig) TerraformAsset

A Terraform Asset takes a file or directory outside of the CDK for Terraform context and moves it into it.

Assets copy referenced files into the stacks context for further usage in other resources. Experimental.

type TerraformAssetConfig added in v0.4.0

type TerraformAssetConfig struct {
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	AssetHash *string `json:"assetHash"`
	// Experimental.
	Type AssetType `json:"type"`
}

Experimental.

type TerraformBackend

type TerraformBackend interface {
	TerraformElement
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Name() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

type TerraformDataSource

type TerraformDataSource interface {
	TerraformElement
	ITerraformDependable
	ITerraformResource
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Count() interface{}
	SetCount(val interface{})
	DependsOn() *[]*string
	SetDependsOn(val *[]*string)
	Fqn() *string
	FriendlyUniqueId() *string
	Lifecycle() *TerraformResourceLifecycle
	SetLifecycle(val *TerraformResourceLifecycle)
	Node() constructs.Node
	Provider() TerraformProvider
	SetProvider(val TerraformProvider)
	RawOverrides() interface{}
	TerraformGeneratorMetadata() *TerraformProviderGeneratorMetadata
	TerraformMetaArguments() *map[string]interface{}
	TerraformResourceType() *string
	AddOverride(path *string, value interface{})
	GetBooleanAttribute(terraformAttribute *string) IResolvable
	GetListAttribute(terraformAttribute *string) *[]*string
	GetNumberAttribute(terraformAttribute *string) *float64
	GetStringAttribute(terraformAttribute *string) *string
	InterpolationForAttribute(terraformAttribute *string) IResolvable
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformDataSource

func NewTerraformDataSource(scope constructs.Construct, id *string, config *TerraformResourceConfig) TerraformDataSource

Experimental.

type TerraformElement

type TerraformElement interface {
	constructs.Construct
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformElement

func NewTerraformElement(scope constructs.Construct, id *string) TerraformElement

Experimental.

type TerraformElementMetadata

type TerraformElementMetadata struct {
	// Experimental.
	Path *string `json:"path"`
	// Experimental.
	StackTrace *[]*string `json:"stackTrace"`
	// Experimental.
	UniqueId *string `json:"uniqueId"`
}

Experimental.

type TerraformHclModule

type TerraformHclModule interface {
	TerraformModule
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	DependsOn() *[]*string
	SetDependsOn(val *[]*string)
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	Providers() *[]interface{}
	RawOverrides() interface{}
	Source() *string
	Variables() *map[string]interface{}
	Version() *string
	AddOverride(path *string, value interface{})
	AddProvider(provider interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	InterpolationForOutput(moduleOutput *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	Set(variable *string, value interface{})
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformHclModule

func NewTerraformHclModule(scope constructs.Construct, id *string, options *TerraformHclModuleOptions) TerraformHclModule

Experimental.

type TerraformHclModuleOptions

type TerraformHclModuleOptions struct {
	// Experimental.
	Source *string `json:"source"`
	// Experimental.
	DependsOn *[]ITerraformDependable `json:"dependsOn"`
	// Experimental.
	Providers *[]interface{} `json:"providers"`
	// Experimental.
	Version *string `json:"version"`
	// Experimental.
	Variables *map[string]interface{} `json:"variables"`
}

Experimental.

type TerraformLocal

type TerraformLocal interface {
	TerraformElement
	ITerraformAddressable
	AsBoolean() IResolvable
	AsList() *[]*string
	AsNumber() *float64
	AsString() *string
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Expression() interface{}
	SetExpression(val interface{})
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformLocal

func NewTerraformLocal(scope constructs.Construct, id *string, expression interface{}) TerraformLocal

Experimental.

type TerraformMetaArguments

type TerraformMetaArguments struct {
	// Experimental.
	Count interface{} `json:"count"`
	// Experimental.
	DependsOn *[]ITerraformDependable `json:"dependsOn"`
	// Experimental.
	Lifecycle *TerraformResourceLifecycle `json:"lifecycle"`
	// Experimental.
	Provider TerraformProvider `json:"provider"`
}

Experimental.

type TerraformModule

type TerraformModule interface {
	TerraformElement
	ITerraformDependable
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	DependsOn() *[]*string
	SetDependsOn(val *[]*string)
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	Providers() *[]interface{}
	RawOverrides() interface{}
	Source() *string
	Version() *string
	AddOverride(path *string, value interface{})
	AddProvider(provider interface{})
	InterpolationForOutput(moduleOutput *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

type TerraformModuleOptions

type TerraformModuleOptions struct {
	// Experimental.
	Source *string `json:"source"`
	// Experimental.
	DependsOn *[]ITerraformDependable `json:"dependsOn"`
	// Experimental.
	Providers *[]interface{} `json:"providers"`
	// Experimental.
	Version *string `json:"version"`
}

Experimental.

type TerraformModuleProvider

type TerraformModuleProvider struct {
	// Experimental.
	ModuleAlias *string `json:"moduleAlias"`
	// Experimental.
	Provider TerraformProvider `json:"provider"`
}

Experimental.

type TerraformOutput

type TerraformOutput interface {
	TerraformElement
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	DependsOn() *[]ITerraformDependable
	SetDependsOn(val *[]ITerraformDependable)
	Description() *string
	SetDescription(val *string)
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	Sensitive() *bool
	SetSensitive(val *bool)
	StaticId() *bool
	SetStaticId(val *bool)
	Value() interface{}
	SetValue(val interface{})
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformOutput

func NewTerraformOutput(scope constructs.Construct, id *string, config *TerraformOutputConfig) TerraformOutput

Experimental.

type TerraformOutputConfig

type TerraformOutputConfig struct {
	// Experimental.
	Value interface{} `json:"value"`
	// Experimental.
	DependsOn *[]ITerraformDependable `json:"dependsOn"`
	// Experimental.
	Description *string `json:"description"`
	// Experimental.
	Sensitive *bool `json:"sensitive"`
	// If set to true the synthesized Terraform Output will be named after the `id` passed to the constructor instead of the default (TerraformOutput.friendlyUniqueId).
	// Experimental.
	StaticId *bool `json:"staticId"`
}

Experimental.

type TerraformProvider

type TerraformProvider interface {
	TerraformElement
	Alias() *string
	SetAlias(val *string)
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	MetaAttributes() *map[string]interface{}
	Node() constructs.Node
	RawOverrides() interface{}
	TerraformGeneratorMetadata() *TerraformProviderGeneratorMetadata
	TerraformProviderSource() *string
	TerraformResourceType() *string
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

type TerraformProviderConfig

type TerraformProviderConfig struct {
	// Experimental.
	TerraformResourceType *string `json:"terraformResourceType"`
	// Experimental.
	TerraformGeneratorMetadata *TerraformProviderGeneratorMetadata `json:"terraformGeneratorMetadata"`
	// Experimental.
	TerraformProviderSource *string `json:"terraformProviderSource"`
}

Experimental.

type TerraformProviderGeneratorMetadata

type TerraformProviderGeneratorMetadata struct {
	// Experimental.
	ProviderName *string `json:"providerName"`
	// Experimental.
	ProviderVersionConstraint *string `json:"providerVersionConstraint"`
}

Experimental.

type TerraformRemoteState

type TerraformRemoteState interface {
	TerraformElement
	ITerraformAddressable
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Fqn() *string
	FriendlyUniqueId() *string
	Node() constructs.Node
	RawOverrides() interface{}
	AddOverride(path *string, value interface{})
	Get(output *string) interface{}
	GetBoolean(output *string) *bool
	GetList(output *string) *[]*string
	GetNumber(output *string) *float64
	GetString(output *string) *string
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

type TerraformResource

type TerraformResource interface {
	TerraformElement
	ITerraformDependable
	ITerraformResource
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Count() interface{}
	SetCount(val interface{})
	DependsOn() *[]*string
	SetDependsOn(val *[]*string)
	Fqn() *string
	FriendlyUniqueId() *string
	Lifecycle() *TerraformResourceLifecycle
	SetLifecycle(val *TerraformResourceLifecycle)
	Node() constructs.Node
	Provider() TerraformProvider
	SetProvider(val TerraformProvider)
	RawOverrides() interface{}
	TerraformGeneratorMetadata() *TerraformProviderGeneratorMetadata
	TerraformMetaArguments() *map[string]interface{}
	TerraformResourceType() *string
	AddOverride(path *string, value interface{})
	GetBooleanAttribute(terraformAttribute *string) IResolvable
	GetListAttribute(terraformAttribute *string) *[]*string
	GetNumberAttribute(terraformAttribute *string) *float64
	GetStringAttribute(terraformAttribute *string) *string
	InterpolationForAttribute(terraformAttribute *string) IResolvable
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformResource

func NewTerraformResource(scope constructs.Construct, id *string, config *TerraformResourceConfig) TerraformResource

Experimental.

type TerraformResourceConfig

type TerraformResourceConfig struct {
	// Experimental.
	Count interface{} `json:"count"`
	// Experimental.
	DependsOn *[]ITerraformDependable `json:"dependsOn"`
	// Experimental.
	Lifecycle *TerraformResourceLifecycle `json:"lifecycle"`
	// Experimental.
	Provider TerraformProvider `json:"provider"`
	// Experimental.
	TerraformResourceType *string `json:"terraformResourceType"`
	// Experimental.
	TerraformGeneratorMetadata *TerraformProviderGeneratorMetadata `json:"terraformGeneratorMetadata"`
}

Experimental.

type TerraformResourceLifecycle

type TerraformResourceLifecycle struct {
	// Experimental.
	CreateBeforeDestroy *bool `json:"createBeforeDestroy"`
	// Experimental.
	IgnoreChanges *[]*string `json:"ignoreChanges"`
	// Experimental.
	PreventDestroy *bool `json:"preventDestroy"`
}

Experimental.

type TerraformStack

type TerraformStack interface {
	constructs.Construct
	Node() constructs.Node
	Synthesizer() IStackSynthesizer
	SetSynthesizer(val IStackSynthesizer)
	AddOverride(path *string, value interface{})
	AllocateLogicalId(tfElement interface{}) *string
	AllProviders() *[]TerraformProvider
	GetLogicalId(tfElement interface{}) *string
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformStack

func NewTerraformStack(scope constructs.Construct, id *string) TerraformStack

Experimental.

func TerraformStack_Of

func TerraformStack_Of(construct constructs.IConstruct) TerraformStack

Experimental.

type TerraformStackMetadata

type TerraformStackMetadata struct {
	// Experimental.
	Backend *string `json:"backend"`
	// Experimental.
	StackName *string `json:"stackName"`
	// Experimental.
	Version *string `json:"version"`
}

Experimental.

type TerraformVariable

type TerraformVariable interface {
	TerraformElement
	ITerraformAddressable
	BooleanValue() *bool
	CdktfStack() TerraformStack
	ConstructNodeMetadata() *map[string]interface{}
	Default() interface{}
	Description() *string
	Fqn() *string
	FriendlyUniqueId() *string
	ListValue() *[]*string
	Node() constructs.Node
	NumberValue() *float64
	RawOverrides() interface{}
	Sensitive() *bool
	StringValue() *string
	Type() *string
	Value() interface{}
	AddOverride(path *string, value interface{})
	OverrideLogicalId(newLogicalId *string)
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	ToMetadata() interface{}
	ToString() *string
	ToTerraform() interface{}
}

Experimental.

func NewTerraformVariable

func NewTerraformVariable(scope constructs.Construct, id *string, config *TerraformVariableConfig) TerraformVariable

Experimental.

type TerraformVariableConfig

type TerraformVariableConfig struct {
	// Experimental.
	Default interface{} `json:"default"`
	// Experimental.
	Description *string `json:"description"`
	// Experimental.
	Sensitive *bool `json:"sensitive"`
	// The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.
	//
	// If no type constraint is set then a value of any type is accepted.
	//
	// While type constraints are optional, we recommend specifying them; they serve as easy reminders for users of the module, and allow Terraform to return a helpful error message if the wrong type is used.
	//
	// Type constraints are created from a mixture of type keywords and type constructors. The supported type keywords are:
	//
	// - string
	// - number
	// - bool
	//
	// The type constructors allow you to specify complex types such as collections:
	//
	// - list(\<TYPE\>)
	// - set(\<TYPE\>)
	// - map(\<TYPE\>)
	// - object({\<ATTR NAME\> = \<TYPE\>, ... })
	// - tuple([\<TYPE\>, ...])
	//
	// The keyword any may be used to indicate that any type is acceptable. For more information on the meaning and behavior of these different types, as well as detailed information about automatic conversion of complex types, see {@link https://www.terraform.io/docs/configuration/types.html|Type Constraints}.
	//
	// If both the type and default arguments are specified, the given default value must be convertible to the specified type.
	// Experimental.
	Type *string `json:"type"`
}

Experimental.

type Testing

type Testing interface {
}

Testing utilities for cdktf applications. Experimental.

type Token

type Token interface {
}

Represents a special or lazily-evaluated value.

Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.

Tokens can be embedded into strings while retaining their original semantics. Experimental.

func NewToken

func NewToken() Token

Experimental.

type Tokenization

type Tokenization interface {
}

Less oft-needed functions to manipulate Tokens. Experimental.

func NewTokenization

func NewTokenization() Tokenization

Experimental.

type TokenizedStringFragments

type TokenizedStringFragments interface {
	FirstToken() IResolvable
	FirstValue() interface{}
	Intrinsic() *[]IResolvable
	Length() *float64
	Literals() *[]IResolvable
	Tokens() *[]IResolvable
	AddIntrinsic(value interface{})
	AddLiteral(lit interface{})
	AddToken(token IResolvable)
	Join(concat IFragmentConcatenator) interface{}
	MapTokens(mapper ITokenMapper) TokenizedStringFragments
}

Fragments of a concatenated string containing stringified Tokens. Experimental.

func NewTokenizedStringFragments

func NewTokenizedStringFragments() TokenizedStringFragments

Experimental.

func Tokenization_ReverseString

func Tokenization_ReverseString(s *string) TokenizedStringFragments

Un-encode a string potentially containing encoded tokens. Experimental.

type VariableType

type VariableType interface {
}

Experimental.

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL