resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Archive provider docs (#14584) 

* Document source block for archive_file data source.

* Add example for archive_file source block.

* Capitalize Optional/Required for consistency with majority of provider docs.
This commit is contained in:
Jeremy Voorhis 2017-05-17 10:41:25 -07:00 committed by Paul Stack
parent f563515655
commit b0ad1b9669
1 changed files with 34 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
website/source/docs/providers/archive/d/archive_file.md
View File

@ -13,31 +13,58 @@ Generates an archive from content, a file, or directory of files.
## Example Usage
```hcl
# Archive a single file.
data "archive_file" "init" {
type = "zip"
source_file = "${path.module}/init.tpl"
output_path = "${path.module}/files/init.zip"
}
# Archive multiple files.
data "archive_file" "dotfiles" {
type = "zip"
output_path = "${path.module}/files/dotfiles.zip"
source {
content = "${data.template_file.vimrc.rendered}"
filename = ".vimrc"
}
source {
content = "${data.template_file.ssh_config.rendered}"
filename = ".ssh/config"
}
}
```
## Argument Reference
The following arguments are supported:
NOTE: One of `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.
NOTE: One of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.
* `type` - (required) The type of archive to generate.
* `type` - (Required) The type of archive to generate.
NOTE: `zip` is supported.
* `output_path` - (required) The output of the archive file.
* `output_path` - (Required) The output of the archive file.
* `source_content` - (optional) Add only this content to the archive with `source_content_filename` as the filename.
* `source_content` - (Optional) Add only this content to the archive with `source_content_filename` as the filename.
* `source_content_filename` - (optional) Set this as the filename when using `source_content`.
* `source_content_filename` - (Optional) Set this as the filename when using `source_content`.
* `source_file` - (optional) Package this file into the archive.
* `source_file` - (Optional) Package this file into the archive.
* `source_dir` - (optional) Package entire contents of this directory into the archive.
* `source_dir` - (Optional) Package entire contents of this directory into the archive.
* `source` - (Optional) Specifies attributes of a single source file to include into the archive.
The `source` block supports the following:
* `content` - (Required) Add this content to the archive with `filename` as the filename.
* `filename` - (Required) Set this as the filename when declaring a `source`.
## Attributes Reference