Add documentation for `description` paramater on `output`.

This commit is contained in:
Gavin Williams 2017-04-06 09:46:18 +01:00 committed by Martin Atkins
parent cc1f00c7fb
commit 4021b0c898
1 changed files with 5 additions and 0 deletions

View File

@ -58,6 +58,11 @@ These are the parameters that can be set:
map. This usually includes an interpolation since outputs that are static map. This usually includes an interpolation since outputs that are static
aren't usually useful. aren't usually useful.
- `description` (optional) - A human-friendly description for the output. This
is primarily for documentation for users using your Terraform configuration. A
future version of Terraform will expose these descriptions as part of some
Terraform CLI command.
- `depends_on` (list of strings) - Explicit dependencies that this output has. - `depends_on` (list of strings) - Explicit dependencies that this output has.
These dependencies will be created before this output value is processed. The These dependencies will be created before this output value is processed. The
dependencies are in the format of `TYPE.NAME`, for example `aws_instance.web`. dependencies are in the format of `TYPE.NAME`, for example `aws_instance.web`.