From 6183b78c3f57a98ec8d8cfb651cbb4d30bd6525b Mon Sep 17 00:00:00 2001 From: team-tf-cdk <84392119+team-tf-cdk@users.noreply.github.com> Date: Wed, 10 Jan 2024 17:21:27 +0100 Subject: [PATCH] cdktf: update index.md,resources/file.md,data-sources/file.md (#293) --- docs/cdktf/python/data-sources/file.md | 2 +- docs/cdktf/python/index.md | 2 +- docs/cdktf/python/resources/file.md | 2 +- docs/cdktf/typescript/data-sources/file.md | 14 +++++++------- docs/cdktf/typescript/index.md | 2 +- docs/cdktf/typescript/resources/file.md | 14 +++++++------- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/cdktf/python/data-sources/file.md b/docs/cdktf/python/data-sources/file.md index d931369d..83995970 100644 --- a/docs/cdktf/python/data-sources/file.md +++ b/docs/cdktf/python/data-sources/file.md @@ -117,4 +117,4 @@ Required: - `content` (String) Add this content to the archive with `filename` as the filename. - `filename` (String) Set this as the filename when declaring a `source`. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/cdktf/python/index.md b/docs/cdktf/python/index.md index ea3e6169..14abfef2 100644 --- a/docs/cdktf/python/index.md +++ b/docs/cdktf/python/index.md @@ -12,4 +12,4 @@ The archive provider exposes resources to manage archive files. This provider requires no configuration. For information on the resources it provides, see the navigation bar. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/cdktf/python/resources/file.md b/docs/cdktf/python/resources/file.md index b280ee4b..bc97713a 100644 --- a/docs/cdktf/python/resources/file.md +++ b/docs/cdktf/python/resources/file.md @@ -52,4 +52,4 @@ Required: - `content` (String) Add this content to the archive with `filename` as the filename. - `filename` (String) Set this as the filename when declaring a `source`. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/cdktf/typescript/data-sources/file.md b/docs/cdktf/typescript/data-sources/file.md index e54c35f3..487a0fb8 100644 --- a/docs/cdktf/typescript/data-sources/file.md +++ b/docs/cdktf/typescript/data-sources/file.md @@ -101,13 +101,13 @@ class MyConvertedCode extends TerraformStack { ### Optional - `excludeSymlinkDirectories` (Boolean) Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`. -- `excludes` (Set of String) Specify files to ignore when reading the `source_dir`. +- `excludes` (Set of String) Specify files to ignore when reading the `sourceDir`. - `outputFileMode` (String) String that specifies the octal file mode for all archived files. For example: `"0666"`. Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior. -- `source` (Block Set) Specifies attributes of a single source file to include into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. (see [below for nested schema](#nestedblock--source)) -- `sourceContent` (String) Add only this content to the archive with `source_content_filename` as the filename. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. -- `sourceContentFilename` (String) Set this as the filename when using `source_content`. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. -- `sourceDir` (String) Package entire contents of this directory into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. -- `sourceFile` (String) Package this file into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. +- `source` (Block Set) Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. (see [below for nested schema](#nestedblock--source)) +- `sourceContent` (String) Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. +- `sourceContentFilename` (String) Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. +- `sourceDir` (String) Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. +- `sourceFile` (String) Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. ### Read-Only @@ -128,4 +128,4 @@ Required: - `content` (String) Add this content to the archive with `filename` as the filename. - `filename` (String) Set this as the filename when declaring a `source`. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/cdktf/typescript/index.md b/docs/cdktf/typescript/index.md index ea3e6169..14abfef2 100644 --- a/docs/cdktf/typescript/index.md +++ b/docs/cdktf/typescript/index.md @@ -12,4 +12,4 @@ The archive provider exposes resources to manage archive files. This provider requires no configuration. For information on the resources it provides, see the navigation bar. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/cdktf/typescript/resources/file.md b/docs/cdktf/typescript/resources/file.md index 4456c92c..a5079910 100644 --- a/docs/cdktf/typescript/resources/file.md +++ b/docs/cdktf/typescript/resources/file.md @@ -25,13 +25,13 @@ description: |- ### Optional - `excludeSymlinkDirectories` (Boolean) Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to `false`. -- `excludes` (Set of String) Specify files to ignore when reading the `source_dir`. +- `excludes` (Set of String) Specify files to ignore when reading the `sourceDir`. - `outputFileMode` (String) String that specifies the octal file mode for all archived files. For example: `"0666"`. Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior. -- `source` (Block Set) Specifies attributes of a single source file to include into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. (see [below for nested schema](#nestedblock--source)) -- `sourceContent` (String) Add only this content to the archive with `source_content_filename` as the filename. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. -- `sourceContentFilename` (String) Set this as the filename when using `source_content`. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. -- `sourceDir` (String) Package entire contents of this directory into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. -- `sourceFile` (String) Package this file into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. +- `source` (Block Set) Specifies attributes of a single source file to include into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. (see [below for nested schema](#nestedblock--source)) +- `sourceContent` (String) Add only this content to the archive with `sourceContentFilename` as the filename. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. +- `sourceContentFilename` (String) Set this as the filename when using `sourceContent`. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. +- `sourceDir` (String) Package entire contents of this directory into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. +- `sourceFile` (String) Package this file into the archive. One and only one of `source`, `sourceContentFilename` (with `sourceContent`), `sourceFile`, or `sourceDir` must be specified. ### Read-Only @@ -52,4 +52,4 @@ Required: - `content` (String) Add this content to the archive with `filename` as the filename. - `filename` (String) Set this as the filename when declaring a `source`. - \ No newline at end of file + \ No newline at end of file