Skip to content

Commit 30f734b

Browse files
committed
update-snippets
1 parent b338989 commit 30f734b

File tree

4 files changed

+39
-28
lines changed

4 files changed

+39
-28
lines changed

examples/python/documentation/functions.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def __init__(self, scope: Construct, id: str):
2929
)
3030
# DOCS_BLOCK_END:functions-usage-example
3131

32-
# DOCS_BLOCK_START:conditional
32+
# DOCS_BLOCK_START:functions-conditional
3333
Instance(
3434
self,
3535
'web',
@@ -39,7 +39,7 @@ def __init__(self, scope: Construct, id: str):
3939
),
4040
instance_type='t2.micro',
4141
)
42-
# DOCS_BLOCK_END:conditional
42+
# DOCS_BLOCK_END:functions-conditional
4343

4444
# INTERNAL NOTE: Due to an JSII bug, we have to pass the variable as a string_value in Python
4545
# We can remove it, once https://github.com/aws/jsii/pull/4209 is released

examples/typescript/documentation/functions.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ import { TerraformStack, TerraformVariable } from "cdktf";
55
import { Construct } from "constructs";
66
import { AwsProvider } from "@cdktf/provider-aws/lib/aws-provider";
77
// DOCS_BLOCK_END:functions
8-
// DOCS_BLOCK_START:conditional
8+
// DOCS_BLOCK_START:functions-conditional
99
import { Token } from "cdktf";
1010
import { Instance } from "@cdktf/provider-aws/lib/instance";
11-
// DOCS_BLOCK_END:conditional
12-
// DOCS_BLOCK_START:conditional,operators,functions,functions-raw
11+
// DOCS_BLOCK_END:functions-conditional
12+
// DOCS_BLOCK_START:functions-conditional,operators,functions,functions-raw
1313
import { Fn } from "cdktf";
14-
// DOCS_BLOCK_END:conditional,operators,functions,functions-raw
14+
// DOCS_BLOCK_END:functions-conditional,operators,functions,functions-raw
1515
// DOCS_BLOCK_START:operators,functions,functions-raw
1616
import { TerraformOutput } from "cdktf";
1717
// DOCS_BLOCK_END:operators,functions,functions-raw
18-
// DOCS_BLOCK_START:conditional,operators,functions-raw
18+
// DOCS_BLOCK_START:functions-conditional,operators,functions-raw
1919
import { Op } from "cdktf";
20-
// DOCS_BLOCK_END:conditional,operators,functions-raw
20+
// DOCS_BLOCK_END:functions-conditional,operators,functions-raw
2121
// DOCS_BLOCK_START:functions-raw,functions
2222
import { DataAwsAvailabilityZones } from "@cdktf/provider-aws/lib/data-aws-availability-zones";
2323
// DOCS_BLOCK_END:functions-raw,functions
@@ -44,15 +44,15 @@ export class FunctionsStack extends TerraformStack {
4444
});
4545
// DOCS_BLOCK_END:functions
4646

47-
// DOCS_BLOCK_START:conditional
47+
// DOCS_BLOCK_START:functions-conditional
4848
new Instance(this, "web", {
4949
ami: "ami-2757f631",
5050
count: Token.asNumber(
5151
Fn.conditional(Op.eq(Token.asAny("terraform.workspace"), "prod"), 2, 1),
5252
),
5353
instanceType: "t2.micro",
5454
});
55-
// DOCS_BLOCK_END:conditional
55+
// DOCS_BLOCK_END:functions-conditional
5656

5757
// DOCS_BLOCK_START:functions-lookup
5858
const v = new TerraformVariable(this, "complex_object", {

website/docs/cdktf/concepts/functions.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ The `element` function gets the first element from the list of Availability Zone
3636
import { TerraformStack, TerraformVariable } from "cdktf";
3737
import { Construct } from "constructs";
3838
import { AwsProvider } from "@cdktf/provider-aws/lib/aws-provider";
39-
import { Fn, TerraformOutput } from "cdktf";
39+
import { Fn } from "cdktf";
40+
import { TerraformOutput } from "cdktf";
4041
import { DataAwsAvailabilityZones } from "@cdktf/provider-aws/lib/data-aws-availability-zones";
4142
export class FunctionsStack extends TerraformStack {
4243
constructor(scope: Construct, id: string) {
@@ -79,15 +80,13 @@ import imports.aws.data_aws_availability_zones.DataAwsAvailabilityZonesConfig;
7980
from cdktf import Fn, TerraformOutput
8081
from imports.aws.provider import AwsProvider
8182
from imports.aws.data_aws_availability_zones import DataAwsAvailabilityZones
82-
8383
zones = DataAwsAvailabilityZones(self, 'zones',
84-
state="available",
85-
)
84+
state="available",
85+
)
8686

8787
TerraformOutput(self, 'first-zone',
8888
value=Fn.element(zones.names, 0)
8989
)
90-
9190
```
9291

9392
```csharp
@@ -192,7 +191,7 @@ new TerraformOutput(this, "first_user_name", {
192191

193192
```python
194193
v = TerraformVariable(self, "complex-object",
195-
type = 'object({users: list(object({name: string}))})',
194+
type='object({users: list(object({name: string}))})',
196195
)
197196
TerraformOutput(self, 'users',
198197
value=Fn.lookup(v.string_value, "users")
@@ -315,7 +314,8 @@ Use the `Op` object to include operators like `!`, `+`, and `-`.
315314
<CodeTabs>
316315

317316
```ts
318-
import { Fn, TerraformOutput } from "cdktf";
317+
import { Fn } from "cdktf";
318+
import { TerraformOutput } from "cdktf";
319319
import { Op } from "cdktf";
320320

321321
const zones = new DataAwsAvailabilityZones(this, "zones", {
@@ -377,7 +377,8 @@ It is also possible to use all built-in Terraform functions without using CDKTF'
377377
<CodeTabs>
378378

379379
```ts
380-
import { Fn, TerraformOutput } from "cdktf";
380+
import { Fn } from "cdktf";
381+
import { TerraformOutput } from "cdktf";
381382
import { Op } from "cdktf";
382383
import { DataAwsAvailabilityZones } from "@cdktf/provider-aws/lib/data-aws-availability-zones";
383384

website/docs/cdktf/concepts/tokens.mdx

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -230,19 +230,29 @@ The inner `Token.as_any()` avoids generating extra quotes `"terraform.workspace"
230230
<!-- #NEXT_CODE_BLOCK_SOURCE:ts examples/typescript/documentation#functions-conditional -->
231231

232232
```python
233-
Instance(
234-
self,
235-
'web',
236-
ami='ami-2757f631',
237-
count=Token.as_number(
238-
Fn.conditional(Op.eq(Token.as_any('terraform.workspace'), 'prod'), 2, 1)
239-
),
240-
instance_type='t2.micro',
241-
)
233+
Instance(
234+
self,
235+
'web',
236+
ami='ami-2757f631',
237+
count=Token.as_number(
238+
Fn.conditional(Op.eq(Token.as_any('terraform.workspace'), 'prod'), 2, 1)
239+
),
240+
instance_type='t2.micro',
241+
)
242242
```
243243

244244
```ts
245-
foo;
245+
import { Token } from "cdktf";
246+
import { Instance } from "@cdktf/provider-aws/lib/instance";
247+
import { Fn } from "cdktf";
248+
import { Op } from "cdktf";
249+
new Instance(this, "web", {
250+
ami: "ami-2757f631",
251+
count: Token.asNumber(
252+
Fn.conditional(Op.eq(Token.asAny("terraform.workspace"), "prod"), 2, 1),
253+
),
254+
instanceType: "t2.micro",
255+
});
246256
```
247257

248258
```terraform

0 commit comments

Comments
 (0)