Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cdktf: update documentation #343

Merged
merged 2 commits into from
Aug 17, 2023
Merged

cdktf: update documentation #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1551625
cdktf: update index.md,resources/txt_record_set.md,resources/srv_reco…
team-tf-cdk Aug 17, 2023
116858c
cdktf: update data-sources/srv_record_set.md,data-sources/ptr_record_…
team-tf-cdk Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/cdktf/python/data-sources/a_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS A records of the host.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, Fn, Token, TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ class MyConvertedCode(TerraformStack):
- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
- `id` (String) Always set to the host.

<!-- cache-key: cdktf-0.17.1 input-09a4ea93af57ab82ae2783bbb8cb9ae3c6be62f7d0a07c7813ff9ad94e5abd5d -->
<!-- cache-key: cdktf-0.18.0 input-09a4ea93af57ab82ae2783bbb8cb9ae3c6be62f7d0a07c7813ff9ad94e5abd5d -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/data-sources/aaaa_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS AAAA records of the host.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, Fn, Token, TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ class MyConvertedCode(TerraformStack):
- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
- `id` (String) Always set to the host.

<!-- cache-key: cdktf-0.17.1 input-7db469a81767808aa5736fa2e189a7fb2686463358a86c8b28dc9ebdfbadcf5f -->
<!-- cache-key: cdktf-0.18.0 input-7db469a81767808aa5736fa2e189a7fb2686463358a86c8b28dc9ebdfbadcf5f -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/data-sources/cname_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS CNAME record set of the host.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ class MyConvertedCode(TerraformStack):
- `cname` (String) A CNAME record associated with host.
- `id` (String) Always set to the host.

<!-- cache-key: cdktf-0.17.1 input-526988da4a181b740911573b2974cc2485ac9a74c080ade941094d59429fbc2f -->
<!-- cache-key: cdktf-0.18.0 input-526988da4a181b740911573b2974cc2485ac9a74c080ade941094d59429fbc2f -->
8 changes: 4 additions & 4 deletions docs/cdktf/python/data-sources/mx_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Use this data source to get DNS MX records for a domain.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, property_access, TerraformStack
from cdktf import TerraformOutput, Fn, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
Expand All @@ -30,7 +30,7 @@ class MyConvertedCode(TerraformStack):
domain="example.com."
)
TerraformOutput(self, "mailserver",
value=property_access(mail.mx, ["0", "exchange"])
value=Fn.lookup_nested(mail.mx, ["0", "exchange"])
)
```

Expand All @@ -54,4 +54,4 @@ Read-Only:
- `exchange` (String)
- `preference` (Number)

<!-- cache-key: cdktf-0.17.1 input-9575c80f774c7f1c604fd43b54ccc2d9aa0c8d3674b276eeeb9bb3ac2deda6ce -->
<!-- cache-key: cdktf-0.18.0 input-9575c80f774c7f1c604fd43b54ccc2d9aa0c8d3674b276eeeb9bb3ac2deda6ce -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/data-sources/ns_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS NS records of the host.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, Fn, Token, TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ class MyConvertedCode(TerraformStack):
- `id` (String) Always set to the domain.
- `nameservers` (List of String) A list of nameservers. Nameservers are always sorted to avoid constant changing plans.

<!-- cache-key: cdktf-0.17.1 input-b7509d9bbecbb92b162ae5c4fe6b7c114b0bf8a6065f82ca109856718298889c -->
<!-- cache-key: cdktf-0.18.0 input-b7509d9bbecbb92b162ae5c4fe6b7c114b0bf8a6065f82ca109856718298889c -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/data-sources/ptr_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS PTR record set of the ip address.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ class MyConvertedCode(TerraformStack):
- `id` (String) Always set to the IP address.
- `ptr` (String) A PTR record associated with `ip_address`.

<!-- cache-key: cdktf-0.17.1 input-d6beeacda97f0da0a4355996a8bafb28efe96db4d1eb9c95620d3ef0e5956989 -->
<!-- cache-key: cdktf-0.18.0 input-d6beeacda97f0da0a4355996a8bafb28efe96db4d1eb9c95620d3ef0e5956989 -->
8 changes: 4 additions & 4 deletions docs/cdktf/python/data-sources/srv_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Use this data source to get DNS SRV records for a service.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, property_access, TerraformStack
from cdktf import TerraformOutput, Fn, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
Expand All @@ -30,7 +30,7 @@ class MyConvertedCode(TerraformStack):
service="_sip._tcp.example.com."
)
TerraformOutput(self, "sipserver",
value=property_access(sip.srv, ["0", "target"])
value=Fn.lookup_nested(sip.srv, ["0", "target"])
)
```

Expand All @@ -56,4 +56,4 @@ Read-Only:
- `target` (String)
- `weight` (Number)

<!-- cache-key: cdktf-0.17.1 input-c6371097320f1bccbccc38d0a7d7f14ca64338962504c690e8b55f2780dca1df -->
<!-- cache-key: cdktf-0.18.0 input-c6371097320f1bccbccc38d0a7d7f14ca64338962504c690e8b55f2780dca1df -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/data-sources/txt_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS TXT record set of the host.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, Fn, Token, TerraformStack
#
Expand Down Expand Up @@ -50,4 +50,4 @@ class MyConvertedCode(TerraformStack):
- `record` (String) The first TXT record.
- `records` (List of String) A list of TXT records.

<!-- cache-key: cdktf-0.17.1 input-8ebca9ff92670e4d1ca03b0569ba41f2cb5c998974060d2b56fd02d99791546f -->
<!-- cache-key: cdktf-0.18.0 input-8ebca9ff92670e4d1ca03b0569ba41f2cb5c998974060d2b56fd02d99791546f -->
6 changes: 3 additions & 3 deletions docs/cdktf/python/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Use the navigation to the left to read about the available resources and data so
Using secret key based transaction authentication (RFC 2845):

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -47,7 +47,7 @@ class MyConvertedCode(TerraformStack):
Using GSS-TSIG (RFC 3645):

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -110,4 +110,4 @@ Optional:
- `realm` (String) The Kerberos realm or Active Directory domain. Value can also be sourced from the DNS_UPDATE_REALM environment variable.
- `username` (String) The name of the user to authenticate as. If not set the current user session will be used. Value can also be sourced from the DNS_UPDATE_USERNAME environment variable.

<!-- cache-key: cdktf-0.17.1 input-e9d4e9807f8ef1b1caf1a5ca0e0557f8226dc5a8c0c28ed2ac43d324ea610807 -->
<!-- cache-key: cdktf-0.18.0 input-e9d4e9807f8ef1b1caf1a5ca0e0557f8226dc5a8c0c28ed2ac43d324ea610807 -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/a_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates an A type DNS record set.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -60,4 +60,4 @@ Import is supported using the following syntax:
terraform import dns_a_record_set.www www.example.com.
```

<!-- cache-key: cdktf-0.17.1 input-aefdcf0febd806b3fd7b613871a56b7d43cc2b893062b5e36090321e3e592b15 -->
<!-- cache-key: cdktf-0.18.0 input-aefdcf0febd806b3fd7b613871a56b7d43cc2b893062b5e36090321e3e592b15 -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/aaaa_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates an AAAA type DNS record set.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -61,4 +61,4 @@ Import is supported using the following syntax:
terraform import dns_aaaa_record_set.www www.example.com.
```

<!-- cache-key: cdktf-0.17.1 input-e351b2d651318b36501b9a8c9b38822b78f62300c58176c5eda249596aa9dc53 -->
<!-- cache-key: cdktf-0.18.0 input-e351b2d651318b36501b9a8c9b38822b78f62300c58176c5eda249596aa9dc53 -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/cname_record.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates a CNAME type DNS record.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -60,4 +60,4 @@ Import is supported using the following syntax:
terraform import dns_cname_record.foo foo.example.com.
```

<!-- cache-key: cdktf-0.17.1 input-94fad5b5fba9781dec461d2e21acefc4daf14ee6fd3cb2ed6a6e1187bf94dc26 -->
<!-- cache-key: cdktf-0.18.0 input-94fad5b5fba9781dec461d2e21acefc4daf14ee6fd3cb2ed6a6e1187bf94dc26 -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/mx_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates an MX type DNS record set.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -88,4 +88,4 @@ Import is supported using the following syntax:
terraform import dns_mx_record_set.mx example.com.
```

<!-- cache-key: cdktf-0.17.1 input-f2608c358a76e252c759888c773fdc9f05b846e571320baecefc4409cb20978e -->
<!-- cache-key: cdktf-0.18.0 input-f2608c358a76e252c759888c773fdc9f05b846e571320baecefc4409cb20978e -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/ns_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates an NS type DNS record set.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -60,4 +60,4 @@ Import is supported using the following syntax:
terraform import dns_ns_record_set.www www.example.com.
```

<!-- cache-key: cdktf-0.17.1 input-fad0da20df2be2ff4f065f1ad567de21e716a39115ff97f7ef2f895a01688223 -->
<!-- cache-key: cdktf-0.18.0 input-fad0da20df2be2ff4f065f1ad567de21e716a39115ff97f7ef2f895a01688223 -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/ptr_record.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates a PTR type DNS record.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -60,4 +60,4 @@ Import is supported using the following syntax:
terraform import dns_ptr_record.dns-sd r._dns-sd.example.com.
```

<!-- cache-key: cdktf-0.17.1 input-743f4ec84754c850a3f6d6afd7a39ee5662b7c41485e67365180c6a52169d75e -->
<!-- cache-key: cdktf-0.18.0 input-743f4ec84754c850a3f6d6afd7a39ee5662b7c41485e67365180c6a52169d75e -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/srv_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates an SRV type DNS record set.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -86,4 +86,4 @@ Import is supported using the following syntax:
terraform import dns_srv_record_set.sip _sip._tcp.example.com.
```

<!-- cache-key: cdktf-0.17.1 input-22ffe02ab7ba511864fe0c2492c236018c65bf3034091ec468a954e13d60b83f -->
<!-- cache-key: cdktf-0.18.0 input-22ffe02ab7ba511864fe0c2492c236018c65bf3034091ec468a954e13d60b83f -->
4 changes: 2 additions & 2 deletions docs/cdktf/python/resources/txt_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates a TXT type DNS record set.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -59,4 +59,4 @@ Import is supported using the following syntax:
terraform import dns_txt_record_set.example example.com.
```

<!-- cache-key: cdktf-0.17.1 input-3ae29c3c376307a7cc9bf659cc5e8d598d659608764611a985ec4b6f86679821 -->
<!-- cache-key: cdktf-0.18.0 input-3ae29c3c376307a7cc9bf659cc5e8d598d659608764611a985ec4b6f86679821 -->
4 changes: 2 additions & 2 deletions docs/cdktf/typescript/data-sources/a_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS A records of the host.
## Example Usage

```typescript
// Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
import { Construct } from "constructs";
import { TerraformOutput, Fn, Token, TerraformStack } from "cdktf";
/*
Expand Down Expand Up @@ -49,4 +49,4 @@ class MyConvertedCode extends TerraformStack {
- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
- `id` (String) Always set to the host.

<!-- cache-key: cdktf-0.17.1 input-09a4ea93af57ab82ae2783bbb8cb9ae3c6be62f7d0a07c7813ff9ad94e5abd5d -->
<!-- cache-key: cdktf-0.18.0 input-09a4ea93af57ab82ae2783bbb8cb9ae3c6be62f7d0a07c7813ff9ad94e5abd5d -->
4 changes: 2 additions & 2 deletions docs/cdktf/typescript/data-sources/aaaa_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS AAAA records of the host.
## Example Usage

```typescript
// Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
import { Construct } from "constructs";
import { TerraformOutput, Fn, Token, TerraformStack } from "cdktf";
/*
Expand Down Expand Up @@ -49,4 +49,4 @@ class MyConvertedCode extends TerraformStack {
- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
- `id` (String) Always set to the host.

<!-- cache-key: cdktf-0.17.1 input-7db469a81767808aa5736fa2e189a7fb2686463358a86c8b28dc9ebdfbadcf5f -->
<!-- cache-key: cdktf-0.18.0 input-7db469a81767808aa5736fa2e189a7fb2686463358a86c8b28dc9ebdfbadcf5f -->
4 changes: 2 additions & 2 deletions docs/cdktf/typescript/data-sources/cname_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get DNS CNAME record set of the host.
## Example Usage

```typescript
// Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
import { Construct } from "constructs";
import { TerraformOutput, TerraformStack } from "cdktf";
/*
Expand Down Expand Up @@ -49,4 +49,4 @@ class MyConvertedCode extends TerraformStack {
- `cname` (String) A CNAME record associated with host.
- `id` (String) Always set to the host.

<!-- cache-key: cdktf-0.17.1 input-526988da4a181b740911573b2974cc2485ac9a74c080ade941094d59429fbc2f -->
<!-- cache-key: cdktf-0.18.0 input-526988da4a181b740911573b2974cc2485ac9a74c080ade941094d59429fbc2f -->
Loading