ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/source/docs/providers/local/r/file.html.md

38 lines
1023 B
Markdown
Raw Normal View History

provider/local: Implement a new local_file resource This commit adds the ability to provision files locally. This is useful for cases where TerraForm generates assets such as TLS certificates or templated documents that need to be saved locally. - While output variables can be used to return values to the user, it is not extremly suitable for large content or when many of these are generated, nor is it practical for operators to manually save them on disk. - While `local-exec` could be used with an `echo`, this provider works across platforms and do not require any convoluted escaping.
2017-03-16 11:51:51 +01:00
---
layout: "local"
page_title: "Local: local_file"
sidebar_current: "docs-local-resource-file"
description: |-
Generates a local file from content.
---
website: documentation tweaks for the local_file resource and its provider
2017-04-17 19:45:10 +02:00
# local_file
provider/local: Implement a new local_file resource This commit adds the ability to provision files locally. This is useful for cases where TerraForm generates assets such as TLS certificates or templated documents that need to be saved locally. - While output variables can be used to return values to the user, it is not extremly suitable for large content or when many of these are generated, nor is it practical for operators to manually save them on disk. - While `local-exec` could be used with an `echo`, this provider works across platforms and do not require any convoluted escaping.
2017-03-16 11:51:51 +01:00
website: documentation tweaks for the local_file resource and its provider
2017-04-17 19:45:10 +02:00
Generates a local file with the given content.
~> **Note** When working with local files, Terraform will detect the resource
as having been deleted each time a configuration is applied on a new machine
where the file is not present and will generate a diff to re-create it. This
may cause "noise" in diffs in environments where configurations are routinely
applied by many different users or within automation systems.
provider/local: Implement a new local_file resource This commit adds the ability to provision files locally. This is useful for cases where TerraForm generates assets such as TLS certificates or templated documents that need to be saved locally. - While output variables can be used to return values to the user, it is not extremly suitable for large content or when many of these are generated, nor is it practical for operators to manually save them on disk. - While `local-exec` could be used with an `echo`, this provider works across platforms and do not require any convoluted escaping.
2017-03-16 11:51:51 +01:00
## Example Usage
website: documentation tweaks for the local_file resource and its provider
2017-04-17 19:45:10 +02:00
```hcl
resource "local_file" "foo" {
provider/local: Implement a new local_file resource This commit adds the ability to provision files locally. This is useful for cases where TerraForm generates assets such as TLS certificates or templated documents that need to be saved locally. - While output variables can be used to return values to the user, it is not extremly suitable for large content or when many of these are generated, nor is it practical for operators to manually save them on disk. - While `local-exec` could be used with an `echo`, this provider works across platforms and do not require any convoluted escaping.
2017-03-16 11:51:51 +01:00
content = "foo!"
filename = "${path.module}/foo.bar"
}
```
## Argument Reference
The following arguments are supported:
website: documentation tweaks for the local_file resource and its provider
2017-04-17 19:45:10 +02:00
* `content` - (Required) The content of file to create.
provider/local: Implement a new local_file resource This commit adds the ability to provision files locally. This is useful for cases where TerraForm generates assets such as TLS certificates or templated documents that need to be saved locally. - While output variables can be used to return values to the user, it is not extremly suitable for large content or when many of these are generated, nor is it practical for operators to manually save them on disk. - While `local-exec` could be used with an `echo`, this provider works across platforms and do not require any convoluted escaping.
2017-03-16 11:51:51 +01:00
website: documentation tweaks for the local_file resource and its provider
2017-04-17 19:45:10 +02:00
* `filename` - (Required) The path of the file to create.
provider/local: Implement a new local_file resource This commit adds the ability to provision files locally. This is useful for cases where TerraForm generates assets such as TLS certificates or templated documents that need to be saved locally. - While output variables can be used to return values to the user, it is not extremly suitable for large content or when many of these are generated, nor is it practical for operators to manually save them on disk. - While `local-exec` could be used with an `echo`, this provider works across platforms and do not require any convoluted escaping.
2017-03-16 11:51:51 +01:00
website: documentation tweaks for the local_file resource and its provider
2017-04-17 19:45:10 +02:00
Any required parent directories will be created automatically, and any existing
file with the given name will be overwritten.