Skip to content

Commit 6923355

Browse files
quixoticmonksebasslash
authored andcommitted
docs: added argument details for tfe_test_variable
1 parent 570c838 commit 6923355

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
ENHANCEMENTS:
44
* `r/tfe_oauth_client`: The `oauth_token` attribute no longer triggers resource replacement unless combined with other replacement-triggering attributes. Use `terraform apply -replace` to force replacement. By @lilincmu [#1825](https://github.com/hashicorp/terraform-provider-tfe/pull/1825)
5+
* `r/tfe_test_variable`: Add missing argument reference and attributes documentation ([#1625](https://github.com/hashicorp/terraform-provider-tfe/issues/1625))
56

67
FEATURES:
78
* `r/tfe_registry_module`: Add `source_directory` and `tag_prefix` registry module support for private registry monorepository, which is a beta feature and not available to all users, by @jillirami ([#1800](https://github.com/hashicorp/terraform-provider-tfe/pull/1800))

website/docs/r/tfe_test_variable.html.markdown

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,25 @@ resource "tfe_test_variable" "tf_test_test_variable" {
5151
```
5252

5353
-> **Note:** Write-Only argument `value_wo` is available to use in place of `value`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments).
54+
55+
## Argument Reference
56+
57+
The following arguments are supported:
58+
59+
* `key` - (Required) Name of the variable.
60+
* `value` - (Optional) Value of the variable. Defaults to `""`. Cannot be used with `value_wo`.
61+
* `value_wo` - (Optional) Value of the variable in write-only mode. Cannot be used with `value`.
62+
* `category` - (Required) Whether this is a Terraform or environment variable. Valid values are `"env"`.
63+
* `description` - (Optional) Description of the variable. Defaults to `""`.
64+
* `hcl` - (Optional) Whether to evaluate the value of the variable as a string of HCL code. Defaults to `false`.
65+
* `sensitive` - (Optional) Whether the value is sensitive. Defaults to `false`.
66+
* `organization` - (Required) Name of the organization.
67+
* `module_name` - (Required) Name of the registry module.
68+
* `module_provider` - (Required) The provider of the registry module.
69+
70+
## Attributes Reference
71+
72+
In addition to all arguments above, the following attributes are exported:
73+
74+
* `id` - The ID of the variable.
75+
* `readable_value` - A non-sensitive read-only copy of the variable value, which can be viewed or referenced in plan outputs without being redacted. Will only be present if the variable is not sensitive.

0 commit comments

Comments
 (0)