Upgrading to CDK for Terraform Version 0.11
0.11 includes improvements to the provider code bindings, to allow referencing maps of computed attributes as a whole map instead of just individual items of that map. Both lists and maps now allow accessing all computed attributes of an assignable property. More control over logging was also added.
TF_VAR_
prefixed environment variables can no longer be accessed at synth time
These environment variables will now be filtered out in the synth phase since they are only intended to be used during diff (plan) and deploy (apply) phases to supply values for TerraformVariable
s. This inhibits accidentally inlining those values into the generated cdk.tf.json
config.
Environment variable and CLI option changes
DEBUG
is replaced by settingCDKTF_LOG_LEVEL=debug
, setting theCDKTF_LOG_LEVEL
to debug will now also behave likeDEBUG=1
and include logs from the provider generationCDKTF_DISABLE_LOGGING=false
is replaced by settingCDKTF_LOG_FILE_DIRECTORY=/path/to/logs/directory
. If left empty no logs will be written.--disable-logging
was removed, instead use the environment variableCDKTF_LOG_LEVEL=off
DISABLE_VERSION_CHECK
,CDKTF_DISABLE_PLUGIN_CACHE_ENV
need to be set totrue
or1
, before anything worked.
Stack ids can no longer contain whitespaces
A TerraformStack
may no longer contain whitespace characters, since we rely on paths being whitespace free. If you have a stack with an id containing a whitespace, please replace it with a hyphen. If the stack was already deployed with the default LocalBackend
you might need to rename your statefile to match the new stack id.
Computed Map References are referenced through getter
For computed maps, the reference is now through a getter.
To access { property = "value" }
, instead of resource.mapAttribute("property")
you can now use resource.mapAttribute.lookup("property")
.
Example
const bucket = new s3.S3Bucket(this, "bucket"); // previouslyconst firstRuleStage = bucket.lifecycleRule.get(0).tags("stage");const firstRuleTags = bucket.get(0).interpolationForAttribute("tags"); // newconst firstRuleStage = bucket.lifecycleRule.get(0).tags.lookup("stage");const firstRuleTags = bucket.lifecycleRule.get(0).tags;
Use ComplexLists and ComplexMaps for complex assignable properties
PR: #1725
Assignable properties of the form Object[]
or { [key: string]: Object }
no longer have setters; they instead have putX
methods. The getter return type is also changed to be a derivative of either ComplexList
or ComplexMap
.
Typescript
// previouslylist.req = ["value"];Fn.lookup(Fn.element(list.req, 0), "reqstr", "default"); // newlist.putReq(["value"]);list.req.get(0).reqstr;
Python
# previouslylist.req = ["value"]Token().as_string(Fn.lookup(Fn.element(list.req, 0), "reqstr", "default")) # newlist.put_req(["value"])list.req.get(0).reqstr
CSharp
// previouslylist.Req = new [] {"value"}Token.AsString(Fn.Lookup(Fn.Element(list.Req, 0), "reqstr", "default")) // newlist.PutReq(new [] {"value"})list.Req.Get(0).Reqstr
Java
// previouslylist.setReq(new string[] {"value"})Token.asString(Fn.lookup(Fn.element(list.getReq(), 0), "reqstr", "default")) // newlist.putReq(new string[] {"value"})list.getReq().get(0).getReqstr()
Go
// previouslylist.Req(&[]*string{jsii.String("value"}))cdktf.Token_AsString(cdktf.Fn_Lookup(cdktf.Fn_Element(list.Req(), jsii.Number(0)), jsii.String("reqstr"), jsii.String("default"))) // newlist.PutReq(&[]*string{jsii.String("value"}))list.Req().Get(jsii.Number(0)).Reqstr()