From 4021b0c898871fe884d3fac3ba241ffa18e9c0d8 Mon Sep 17 00:00:00 2001 From: Gavin Williams Date: Thu, 6 Apr 2017 09:46:18 +0100 Subject: [PATCH] Add documentation for `description` paramater on `output`. --- website/source/docs/configuration/outputs.html.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/source/docs/configuration/outputs.html.md b/website/source/docs/configuration/outputs.html.md index a4a4b4a17e..1e0323c346 100644 --- a/website/source/docs/configuration/outputs.html.md +++ b/website/source/docs/configuration/outputs.html.md @@ -58,6 +58,11 @@ These are the parameters that can be set: map. This usually includes an interpolation since outputs that are static 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. 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`.