Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of Update the docs for tfstack config output blocks into v1.9 #36354

Draft
wants to merge 2 commits into
base: v1.9
Choose a base branch
from
Draft

Backport of Update the docs for tfstack config output blocks into v1.9 #36354

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3053773
backport of commit 8152716681d972cc2392322cd850c3e69ee215a9
nfagerlund Jan 16, 2025
a206ffa
backport of commit e5891b005ab46cb565502392bf4c942ed85d6ac9
nfagerlund Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion website/docs/language/stacks/reference/tfstack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,18 @@ This section provides details about the fields you can configure in the `variabl

Use the `output` block to make information about your infrastructure available in the HCP Terraform UI to expose information about your Stack. The `output` block functions the same way in Stack configuration as it does in traditional Terraform configurations with a few small differences.

In Stack configurations, `output` blocks do not support the `type` or `sensitive` fields, and they do not support the `preconditions` argument. Learn more about [Outputs](/terraform/language/values/outputs).
In Stack configurations, `output` blocks require the `type` argument, and they do not support the `preconditions` block. Learn more about [Outputs](/terraform/language/values/outputs).

### Complete configuration

When every field is defined, an `output` block has the following form:
```hcl
output "unique_name_of_output" {
description = "Description of the purpose of this output"
type = string
value = component.component_name.some_value
sensitive = false
ephemeral = false
}
```

Expand All @@ -119,7 +122,10 @@ This section provides details about the fields you can configure in the `output`
| Field | Description | Type | Required |
| :---- | :---- | :---- | :---- |
| `description` | A human-friendly description for the output. | string | Optional |
| `type` | The type of the output. | type constraint | Required |
| `value` | The value to output. | any | Required |
| `sensitive` | Marks the variable as sensitive, which prevents its value from being displayed in logs or in the HCP Terraform UI. | bool | Optional |
| `ephemeral` | Whether to exclude the value from plans and state data. | bool | Optional |

## `required_providers` and `provider` block configuration

Expand Down