Skip to content

Commit e5bbe45

Browse files
authored
cdktf: update index.html.markdown,r/workspace_variable_set.html.markdown,r/workspace_settings.markdown,r/workspace_run_task.html.markdown,r/workspace_run.html.markdown,r/workspace_policy_set_exclusion.html.markdown,r/workspace_policy_set.html.markdown,r/workspace.html.markdown,r/variable_set.html.markdown,r/variable.html.markdown,r/tfe_test_variable.html.markdown,r/terraform_version.html.markdown,r/team_token.html.markdown,r/team_project_access.html.markdown,r/team_organization_members.html.markdown,r/team_organization_member.html.markdown,r/team_notification_configuration.html.markdown,r/team_members.html.markdown,r/team_member.html.markdown,r/team_access.html.markdown,r/team.html.markdown,r/stack.html.markdown,r/ssh_key.html.markdown,r/sentinel_version.html.markdown,r/sentinel_policy.html.markdown,r/saml_settings.html.markdown,r/run_trigger.html.markdown,r/registry_provider.html.markdown,r/registry_module.html.markdown,r/registry_gpg_key.html.markdown,r/project_variable_set.html.markdown,r/project_policy_set.html.markdown,r/project_oauth_client.html.markdown,r/project.html.markdown,r/policy_set_parameter.html.markdown,r/policy_set.html.markdown,r/policy.html.markdown,r/organization_token.html.markdown,r/organization_run_task_global_settings.html.markdown,r/organization_run_task.html.markdown,r/organization_module_sharing.html.markdown,r/organization_membership.html.markdown,r/organization_default_settings.html.markdown,r/organization.html.markdown,r/opa_version.html.markdown,r/oauth_client.html.markdown,r/notification_configuration.html.markdown,r/no_code_module.html.markdown,r/data_retention_policy.html.markdown,r/audit_trail_token.html.markdown,r/agent_token.html.markdown,r/agent_pool_allowed_workspaces.html.markdown,r/agent_pool.html.markdown,r/admin_organization_settings.markdown,ephemeral-resources/team_token.html.markdown,ephemeral-resources/organization_token.html.markdown,ephemeral-resources/agent_token.html.markdown,d/workspace_run_task.html.markdown,d/workspace_ids.html.markdown,d/workspace.html.markdown,d/variables.html.markdown,d/variable_set.html.markdown,d/teams.html.markdown,d/team_project_access.html.markdown,d/team_access.html.markdown,d/team.html.markdown,d/ssh_key.html.markdown,d/slug.html.markdown,d/saml_settings.html.markdown,d/registry_providers.html.markdown,d/registry_provider.html.markdown,d/registry_gpg_keys.html.markdown,d/registry_gpg_key.html.markdown,d/projects.html.markdown,d/project.html.markdown,d/policy_set.html.markdown,d/outputs.html.markdown,d/organizations.html.markdown,d/organization_tags.html.markdown,d/organization_run_task_global_settings.html.markdown,d/organization_run_task.html.markdown,d/organization_membership.html.markdown,d/organization_members.html.markdown,d/organization.html.markdown,d/oauth_client.html.markdown,d/no_code_module.html.markdown,d/ip_ranges.html.markdown,d/github_app_installation.html.markdown,d/agent_pool.html.markdown (#1662)
1 parent 128626d commit e5bbe45

8 files changed

+105
-34
lines changed

website/docs/cdktf/python/r/organization_run_task.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ import ID. For example:
6262
```shell
6363
terraform import tfe_organization_run_task.test my-org-name/task-name
6464
```
65-
66-
<!-- cache-key: cdktf-0.20.8 input-707bd6c45e92501e9b281496a53813c5d762c2e3a9e6a153060c375f160019e6 -->
65+
-> **Note:** Write-Only argument `hmac_key_wo` is available to use in place of `hmac_key`. 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).
66+
<!-- cache-key: cdktf-0.20.8 input-91c45f6554a40c95a02a693f26d13fec2e11f5cf24033d1f8864c9e8a25d43be -->

website/docs/cdktf/python/r/policy_set_parameter.html.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,6 @@ example:
7272
terraform import tfe_policy_set_parameter.test polset-wAs3zYmWAhYK7peR/var-5rTwnSaRPogw6apb
7373
```
7474

75+
-> **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).
7576

76-
<!-- cache-key: cdktf-0.20.8 input-3d439f538435c91fac393d64ba8c1ac4db8481770f20e794bdb2cde671211a74 -->
77+
<!-- cache-key: cdktf-0.20.8 input-187122d94383c3f0a1bf8f37a537c91855fb7d3649f9b9c5384c4261bf4b184a -->

website/docs/cdktf/python/r/tfe_test_variable.html.markdown

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Creates, updates and destroys environment variables used for testing in the Priv
1616
```python
1717
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
19-
from cdktf import Token, TerraformStack
19+
from cdktf import TerraformStack
2020
#
2121
# Provider bindings are generated by running `cdktf get`.
2222
# See https://cdk.tf/provider-generation for more details.
@@ -28,18 +28,18 @@ from imports.tfe.test_variable import TestVariable
2828
class MyConvertedCode(TerraformStack):
2929
def __init__(self, scope, name):
3030
super().__init__(scope, name)
31-
OauthClient(self, "test_client",
31+
test_org = Organization(self, "test_org",
32+
33+
name="my-org-name"
34+
)
35+
test_client = OauthClient(self, "test_client",
3236
api_url="https://api.github.com",
3337
http_url="https://github.com",
3438
oauth_token="my-token-123",
35-
organization=test.name,
39+
organization=test_org.name,
3640
service_provider="github"
3741
)
38-
Organization(self, "test_org",
39-
40-
name="my-org-name"
41-
)
42-
RegistryModule(self, "test_module",
42+
test_module = RegistryModule(self, "test_module",
4343
organization="test-module",
4444
test_config=[RegistryModuleTestConfig(
4545
tests_enabled=True
@@ -49,19 +49,21 @@ class MyConvertedCode(TerraformStack):
4949
branch="main",
5050
display_identifier="GH_NAME/REPO_NAME",
5151
identifier="GH_NAME/REPO_NAME",
52-
oauth_token_id=Token.as_string(tfe_oauth_client_test.oauth_token_id),
52+
oauth_token_id=test_client.oauth_token_id,
5353
tags=False
5454
)
5555
)
5656
TestVariable(self, "tf_test_test_variable",
5757
category="env",
5858
description="some description",
5959
key="key_test",
60-
module_name=Token.as_string(tfe_registry_module_test.name),
61-
module_provider=Token.as_string(tfe_registry_module_test.module_provider),
62-
organization=test.name,
60+
module_name=test_module.name,
61+
module_provider=test_module.module_provider,
62+
organization=test_org.name,
6363
value="value_test"
6464
)
6565
```
6666

67-
<!-- cache-key: cdktf-0.20.8 input-55e49524af609900a690bb550f1798527423cd4803ee6d444b17f6541076474b -->
67+
-> **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).
68+
69+
<!-- cache-key: cdktf-0.20.8 input-4264417bf24f9d477b2ff4c6d7f38f5800d38eaa9e1b0c6199091d7366758841 -->

website/docs/cdktf/python/r/variable.html.markdown

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,41 @@ class MyConvertedCode(TerraformStack):
9494
)
9595
```
9696

97+
Basic usage for the write-only value of tfe_variable:
98+
99+
```python
100+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
101+
from constructs import Construct
102+
from cdktf import VariableType, TerraformVariable, Token, TerraformStack
103+
#
104+
# Provider bindings are generated by running `cdktf get`.
105+
# See https://cdk.tf/provider-generation for more details.
106+
#
107+
from imports.tfe.variable import Variable
108+
class MyConvertedCode(TerraformStack):
109+
def __init__(self, scope, name):
110+
super().__init__(scope, name)
111+
# Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
112+
# You can read more about this at https://cdk.tf/variables
113+
session_token = TerraformVariable(self, "session_token",
114+
type=VariableType.STRING
115+
)
116+
Variable(self, "test",
117+
category="terraform",
118+
description="a useful description",
119+
key="my_key_name",
120+
value_wo=session_token.value,
121+
workspace_id=Token.as_string(tfe_workspace_test.id)
122+
)
123+
```
124+
97125
## Argument Reference
98126

99127
The following arguments are supported:
100128

101129
* `key` - (Required) Name of the variable.
102130
* `value` - (Required) Value of the variable.
131+
* `value_wo` - (Optional) Write-Only value of the variable. `write-only` values are never stored to state and do not display in the Terraform plan output. Set the `sensitive` argument to `true` to not display its value in the `Variables` UI for HCP. If the value passed to `value_wo` changes, it will force to recreate the resource.
103132
* `category` - (Required) Whether this is a Terraform or environment variable.
104133
Valid values are `terraform` or `env`.
105134
* `description` - (Optional) Description of the variable.
@@ -117,6 +146,8 @@ Terraform will only change the value for a sensitive variable if you change
117146
`value` in the configuration, so that it no longer matches the last known value
118147
in the state.
119148

149+
-> **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).
150+
120151
## Attributes Reference
121152

122153
* `id` - The ID of the variable.
@@ -189,4 +220,4 @@ example:
189220
terraform import tfe_variable.test my-org-name/varset-47qC3LmA47piVan7/var-5rTwnSaRPogw6apb
190221
```
191222

192-
<!-- cache-key: cdktf-0.20.8 input-820a46294ad3c295e8c8e473e6b35e04caffa032e0ef22d9cdce3378630f170e -->
223+
<!-- cache-key: cdktf-0.20.8 input-19607c5a22ab7e0c64d183fd70bb467e8afa7b5badcb319081a8626aa732f9e4 -->

website/docs/cdktf/typescript/r/organization_run_task.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,5 +65,5 @@ import ID. For example:
6565
```shell
6666
terraform import tfe_organization_run_task.test my-org-name/task-name
6767
```
68-
69-
<!-- cache-key: cdktf-0.20.8 input-707bd6c45e92501e9b281496a53813c5d762c2e3a9e6a153060c375f160019e6 -->
68+
-> **Note:** Write-Only argument `hmac_key_wo` is available to use in place of `hmacKey`. 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).
69+
<!-- cache-key: cdktf-0.20.8 input-91c45f6554a40c95a02a693f26d13fec2e11f5cf24033d1f8864c9e8a25d43be -->

website/docs/cdktf/typescript/r/policy_set_parameter.html.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,6 @@ example:
7575
terraform import tfe_policy_set_parameter.test polset-wAs3zYmWAhYK7peR/var-5rTwnSaRPogw6apb
7676
```
7777

78+
-> **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).
7879

79-
<!-- cache-key: cdktf-0.20.8 input-3d439f538435c91fac393d64ba8c1ac4db8481770f20e794bdb2cde671211a74 -->
80+
<!-- cache-key: cdktf-0.20.8 input-187122d94383c3f0a1bf8f37a537c91855fb7d3649f9b9c5384c4261bf4b184a -->

website/docs/cdktf/typescript/r/tfe_test_variable.html.markdown

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Creates, updates and destroys environment variables used for testing in the Priv
1616
```typescript
1717
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
import { Construct } from "constructs";
19-
import { Token, TerraformStack } from "cdktf";
19+
import { TerraformStack } from "cdktf";
2020
/*
2121
* Provider bindings are generated by running `cdktf get`.
2222
* See https://cdk.tf/provider-generation for more details.
@@ -28,18 +28,18 @@ import { TestVariable } from "./.gen/providers/tfe/test-variable";
2828
class MyConvertedCode extends TerraformStack {
2929
constructor(scope: Construct, name: string) {
3030
super(scope, name);
31-
new OauthClient(this, "test_client", {
31+
const testOrg = new Organization(this, "test_org", {
32+
33+
name: "my-org-name",
34+
});
35+
const testClient = new OauthClient(this, "test_client", {
3236
apiUrl: "https://api.github.com",
3337
httpUrl: "https://github.com",
3438
oauthToken: "my-token-123",
35-
organization: test.name,
39+
organization: testOrg.name,
3640
serviceProvider: "github",
3741
});
38-
new Organization(this, "test_org", {
39-
40-
name: "my-org-name",
41-
});
42-
new RegistryModule(this, "test_module", {
42+
const testModule = new RegistryModule(this, "test_module", {
4343
organization: "test-module",
4444
testConfig: [
4545
{
@@ -50,22 +50,24 @@ class MyConvertedCode extends TerraformStack {
5050
branch: "main",
5151
displayIdentifier: "GH_NAME/REPO_NAME",
5252
identifier: "GH_NAME/REPO_NAME",
53-
oauthTokenId: Token.asString(tfeOauthClientTest.oauthTokenId),
53+
oauthTokenId: testClient.oauthTokenId,
5454
tags: false,
5555
},
5656
});
5757
new TestVariable(this, "tf_test_test_variable", {
5858
category: "env",
5959
description: "some description",
6060
key: "key_test",
61-
moduleName: Token.asString(tfeRegistryModuleTest.name),
62-
moduleProvider: Token.asString(tfeRegistryModuleTest.moduleProvider),
63-
organization: test.name,
61+
moduleName: testModule.name,
62+
moduleProvider: testModule.moduleProvider,
63+
organization: testOrg.name,
6464
value: "value_test",
6565
});
6666
}
6767
}
6868

6969
```
7070

71-
<!-- cache-key: cdktf-0.20.8 input-55e49524af609900a690bb550f1798527423cd4803ee6d444b17f6541076474b -->
71+
-> **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).
72+
73+
<!-- cache-key: cdktf-0.20.8 input-4264417bf24f9d477b2ff4c6d7f38f5800d38eaa9e1b0c6199091d7366758841 -->

website/docs/cdktf/typescript/r/variable.html.markdown

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,44 @@ class MyConvertedCode extends TerraformStack {
100100

101101
```
102102

103+
Basic usage for the write-only value of tfe_variable:
104+
105+
```typescript
106+
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
107+
import { Construct } from "constructs";
108+
import { VariableType, TerraformVariable, Token, TerraformStack } from "cdktf";
109+
/*
110+
* Provider bindings are generated by running `cdktf get`.
111+
* See https://cdk.tf/provider-generation for more details.
112+
*/
113+
import { Variable } from "./.gen/providers/tfe/variable";
114+
class MyConvertedCode extends TerraformStack {
115+
constructor(scope: Construct, name: string) {
116+
super(scope, name);
117+
/*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
118+
You can read more about this at https://cdk.tf/variables*/
119+
const sessionToken = new TerraformVariable(this, "session_token", {
120+
type: VariableType.STRING,
121+
});
122+
new Variable(this, "test", {
123+
category: "terraform",
124+
description: "a useful description",
125+
key: "my_key_name",
126+
value_wo: sessionToken.value,
127+
workspaceId: Token.asString(tfeWorkspaceTest.id),
128+
});
129+
}
130+
}
131+
132+
```
133+
103134
## Argument Reference
104135

105136
The following arguments are supported:
106137

107138
* `key` - (Required) Name of the variable.
108139
* `value` - (Required) Value of the variable.
140+
* `value_wo` - (Optional) Write-Only value of the variable. `write-only` values are never stored to state and do not display in the Terraform plan output. Set the `sensitive` argument to `true` to not display its value in the `Variables` UI for HCP. If the value passed to `value_wo` changes, it will force to recreate the resource.
109141
* `category` - (Required) Whether this is a Terraform or environment variable.
110142
Valid values are `terraform` or `env`.
111143
* `description` - (Optional) Description of the variable.
@@ -123,6 +155,8 @@ Terraform will only change the value for a sensitive variable if you change
123155
`value` in the configuration, so that it no longer matches the last known value
124156
in the state.
125157

158+
-> **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).
159+
126160
## Attributes Reference
127161

128162
* `id` - The ID of the variable.
@@ -198,4 +232,4 @@ example:
198232
terraform import tfe_variable.test my-org-name/varset-47qC3LmA47piVan7/var-5rTwnSaRPogw6apb
199233
```
200234

201-
<!-- cache-key: cdktf-0.20.8 input-820a46294ad3c295e8c8e473e6b35e04caffa032e0ef22d9cdce3378630f170e -->
235+
<!-- cache-key: cdktf-0.20.8 input-19607c5a22ab7e0c64d183fd70bb467e8afa7b5badcb319081a8626aa732f9e4 -->

0 commit comments

Comments
 (0)