terraform/website/source/docs/providers/archive/r/file.html.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

---
layout: "archive"
page_title: "Archive: archive_file"
sidebar_current: "docs-archive-resource-file"
description: |-
Generates an archive from content, a file, or directory of files.
---
# archive\_file
Generates an archive from content, a file, or directory of files.
## Example Usage
```
resource "archive_file" "init" {
type = "zip"
source_content_filename = "${path.module}/init.tpl"
output_path = "${path.module}/files/init.zip"
}
```
## Argument Reference
The following arguments are supported:
NOTE: One of `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified.
* `type` - (required) The type of archive to generate.
NOTE: `zip` is supported.
* `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_filename` - (optional) Set this as the filename when using `source_content`.
* `source_file` - (optional) Package this file into the archive.
* `source_dir` - (optional) Package entire contents of this directory into the archive.
## Attributes Reference
The following attributes are exported:
* `output_size` - The size of the output archive file.
* `output_sha` - The SHA1 checksum of output archive file.