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

cdktf: update documentation #281

Merged
merged 1 commit into from
Jan 10, 2024
Merged

cdktf: update documentation #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/cdktf/python/data-sources/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ class MyConvertedCode(TerraformStack):
- `content_sha256` (String) SHA256 checksum of file content.
- `content_sha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-22846c8e38e6f714068d3582c83fc3ae8641fce78069cb2dad73e0cda111bb6e 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-22846c8e38e6f714068d3582c83fc3ae8641fce78069cb2dad73e0cda111bb6e -->
2 changes: 1 addition & 1 deletion docs/cdktf/python/data-sources/sensitive_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ class MyConvertedCode(TerraformStack):
- `content_sha256` (String) SHA256 checksum of file content.
- `content_sha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-243d28f9fdd6244e13235ce959995e72a682fd59c3cd757ba3472b00692c417c 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-243d28f9fdd6244e13235ce959995e72a682fd59c3cd757ba3472b00692c417c -->
2 changes: 1 addition & 1 deletion docs/cdktf/python/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ its assumptions. The resources here are best used with care, since depending
on local state can make it hard to apply the same Terraform configuration on
many different local systems where the local resources may not be universally
available. See specific notes in each resource for more information.
<!-- cache-key: cdktf-0.19.0 input-422e6a0607950a31f3f628fa80a723f639c68e72168070b59d8f5b254d354249 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-422e6a0607950a31f3f628fa80a723f639c68e72168070b59d8f5b254d354249 -->
2 changes: 1 addition & 1 deletion docs/cdktf/python/resources/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ class MyConvertedCode(TerraformStack):
- `content_sha256` (String) SHA256 checksum of file content.
- `content_sha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-c00971f3974a95322b857b196ceb51dd0a0d43df77870f8acdaed566bf74c9e0 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-c00971f3974a95322b857b196ceb51dd0a0d43df77870f8acdaed566bf74c9e0 -->
2 changes: 1 addition & 1 deletion docs/cdktf/python/resources/sensitive_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ class MyConvertedCode(TerraformStack):
- `content_sha256` (String) SHA256 checksum of file content.
- `content_sha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-7bb75dc158cfada4bb631b2df7be8efc625955008a732af3f0752e8d4cc306fb 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-7bb75dc158cfada4bb631b2df7be8efc625955008a732af3f0752e8d4cc306fb -->
2 changes: 1 addition & 1 deletion docs/cdktf/typescript/data-sources/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ class MyConvertedCode extends TerraformStack {
- `contentSha256` (String) SHA256 checksum of file content.
- `contentSha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-22846c8e38e6f714068d3582c83fc3ae8641fce78069cb2dad73e0cda111bb6e 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-22846c8e38e6f714068d3582c83fc3ae8641fce78069cb2dad73e0cda111bb6e -->
2 changes: 1 addition & 1 deletion docs/cdktf/typescript/data-sources/sensitive_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ class MyConvertedCode extends TerraformStack {
- `contentSha256` (String) SHA256 checksum of file content.
- `contentSha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-243d28f9fdd6244e13235ce959995e72a682fd59c3cd757ba3472b00692c417c 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-243d28f9fdd6244e13235ce959995e72a682fd59c3cd757ba3472b00692c417c -->
2 changes: 1 addition & 1 deletion docs/cdktf/typescript/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ its assumptions. The resources here are best used with care, since depending
on local state can make it hard to apply the same Terraform configuration on
many different local systems where the local resources may not be universally
available. See specific notes in each resource for more information.
<!-- cache-key: cdktf-0.19.0 input-422e6a0607950a31f3f628fa80a723f639c68e72168070b59d8f5b254d354249 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-422e6a0607950a31f3f628fa80a723f639c68e72168070b59d8f5b254d354249 -->
12 changes: 6 additions & 6 deletions docs/cdktf/typescript/resources/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ File content must be specified with _exactly_ one of the arguments `content`,
`sensitiveContent` (Deprecated), `contentBase64`, or `source`.

-> If the file content is sensitive, use the
[`localSensitiveFile`](./sensitive_file.html) resource instead.
[`local_sensitive_file`](./sensitive_file.html) resource instead.

## Example Usage

Expand Down Expand Up @@ -60,10 +60,10 @@ class MyConvertedCode extends TerraformStack {
### Optional

- `content` (String) Content to store in the file, expected to be a UTF-8 encoded string.
Conflicts with `sensitive_content`, `content_base64` and `source`.
Conflicts with `sensitiveContent`, `contentBase64` and `source`.
Exactly one of these four arguments must be specified.
- `contentBase64` (String) Content to store in the file, expected to be binary encoded as base64 string.
Conflicts with `content`, `sensitive_content` and `source`.
Conflicts with `content`, `sensitiveContent` and `source`.
Exactly one of these four arguments must be specified.
- `directoryPermission` (String) Permissions to set for directories created (before umask), expressed as string in
[numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation).
Expand All @@ -73,12 +73,12 @@ class MyConvertedCode extends TerraformStack {
Default value is `"0777"`.
- `sensitiveContent` (String, Sensitive, Deprecated) Sensitive content to store in the file, expected to be an UTF-8 encoded string.
Will not be displayed in diffs.
Conflicts with `content`, `content_base64` and `source`.
Conflicts with `content`, `contentBase64` and `source`.
Exactly one of these four arguments must be specified.
If in need to use _sensitive_ content, please use the [`local_sensitive_file`](./sensitive_file.html)
resource instead.
- `source` (String) Path to file to use as source for the one we are creating.
Conflicts with `content`, `sensitive_content` and `content_base64`.
Conflicts with `content`, `sensitiveContent` and `contentBase64`.
Exactly one of these four arguments must be specified.

### Read-Only
Expand All @@ -90,4 +90,4 @@ class MyConvertedCode extends TerraformStack {
- `contentSha256` (String) SHA256 checksum of file content.
- `contentSha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-c00971f3974a95322b857b196ceb51dd0a0d43df77870f8acdaed566bf74c9e0 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-c00971f3974a95322b857b196ceb51dd0a0d43df77870f8acdaed566bf74c9e0 -->
6 changes: 3 additions & 3 deletions docs/cdktf/typescript/resources/sensitive_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class MyConvertedCode extends TerraformStack {
### Optional

- `content` (String, Sensitive) Sensitive Content to store in the file, expected to be a UTF-8 encoded string.
Conflicts with `content_base64` and `source`.
Conflicts with `contentBase64` and `source`.
Exactly one of these three arguments must be specified.
- `contentBase64` (String, Sensitive) Sensitive Content to store in the file, expected to be binary encoded as base64 string.
Conflicts with `content` and `source`.
Expand All @@ -72,7 +72,7 @@ class MyConvertedCode extends TerraformStack {
[numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation).
Default value is `"0700"`.
- `source` (String) Path to file to use as source for the one we are creating.
Conflicts with `content` and `content_base64`.
Conflicts with `content` and `contentBase64`.
Exactly one of these three arguments must be specified.

### Read-Only
Expand All @@ -84,4 +84,4 @@ class MyConvertedCode extends TerraformStack {
- `contentSha256` (String) SHA256 checksum of file content.
- `contentSha512` (String) SHA512 checksum of file content.
- `id` (String) The hexadecimal encoding of the SHA1 checksum of the file content.
<!-- cache-key: cdktf-0.19.0 input-7bb75dc158cfada4bb631b2df7be8efc625955008a732af3f0752e8d4cc306fb 556251879b8ed0dc4c87a76b568667e0ab5e2c46efdd14a05c556daf05678783-->
<!-- cache-key: cdktf-0.20.0 input-7bb75dc158cfada4bb631b2df7be8efc625955008a732af3f0752e8d4cc306fb -->
Loading