Skip to content

Commit e89d1b8

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/outputs.html.markdown,ephemeral-resources/organization_token.html.markdown,ephemeral-resources/audit_trail.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 (#1677)
1 parent e7c08f5 commit e89d1b8

18 files changed

+363
-22
lines changed

website/docs/cdktf/python/d/ssh_key.html.markdown

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,13 @@ class MyConvertedCode(TerraformStack):
3636
The following arguments are supported:
3737

3838
* `name` - (Required) Name of the SSH key.
39-
* `organization` - (Required) Name of the organization.
39+
* `organization` - (Optional) Name of the organization. If omitted, organization
40+
must be defined in the provider config.
4041

4142
## Attributes Reference
4243

4344
In addition to all arguments above, the following attributes are exported:
4445

4546
* `id` - The ID of the SSH key.
4647

47-
<!-- cache-key: cdktf-0.20.8 input-806b3725b385ea145f9913c0e0d9cd7b045ae9faf7bb22bbddfa40eda1fb10e3 -->
48+
<!-- cache-key: cdktf-0.20.8 input-eb29ed64f702678fe5f4e16b19cee416f189775eb585e2b64df226614d29f489 -->
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: Ephemeral: tfe_audit_trail_token"
4+
description: |-
5+
Generates a new audit trail token that is guaranteed not to be written to
6+
state.
7+
---
8+
9+
10+
<!-- Please do not edit this file, it is generated. -->
11+
# Ephemeral: tfe_audit_trail_token
12+
13+
Terraform ephemeral resource for managing a TFE audit trail token. This
14+
resource is used to generate a new audit trail token that is guaranteed not to
15+
be written to state. Since audit trail tokens are singleton resources, using this ephemeral resource will replace any existing audit trail token, including those managed by `tfe_audit_trail_token`.
16+
17+
~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral).
18+
19+
## Example Usage
20+
21+
### Generate a new audit trail token:
22+
23+
This will invalidate any existing audit trail token.
24+
25+
```python
26+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
27+
from constructs import Construct
28+
from cdktf import TerraformStack
29+
class MyConvertedCode(TerraformStack):
30+
def __init__(self, scope, name):
31+
super().__init__(scope, name)
32+
```
33+
34+
### Generate a new audit trail token with 30 day expiration:
35+
36+
This will invalidate any existing audit trail token.
37+
38+
```python
39+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
40+
from constructs import Construct
41+
from cdktf import TerraformStack
42+
#
43+
# Provider bindings are generated by running `cdktf get`.
44+
# See https://cdk.tf/provider-generation for more details.
45+
#
46+
from imports.time.rotating import Rotating
47+
class MyConvertedCode(TerraformStack):
48+
def __init__(self, scope, name):
49+
super().__init__(scope, name)
50+
# The following providers are missing schema information and might need manual adjustments to synthesize correctly: time.
51+
# For a more precise conversion please use the --provider flag in convert.
52+
Rotating(self, "example",
53+
rotation_days=30
54+
)
55+
```
56+
57+
## Argument Reference
58+
59+
The following arguments are required:
60+
61+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
62+
63+
The following arguments are optional:
64+
65+
* `expired_at` - (Optional) The token's expiration date. The expiration date must be a date/time string in RFC3339
66+
format (e.g., "2024-12-31T23:59:59Z"). If no expiration date is supplied, the expiration date will default to null and
67+
never expire.
68+
69+
This ephemeral resource exports the following attributes in addition to the arguments above:
70+
71+
* `token` - The generated token. This value is sensitive and will not be stored
72+
in state.
73+
74+
<!-- cache-key: cdktf-0.20.8 input-e07431295fe6b9a13a56067153dda5e847e37938339557dc88c8b7ea2ebd4dcd -->
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: Ephemeral: tfe_outputs"
4+
description: |-
5+
Get output values from another organization/workspace without writing
6+
sensitive data to state.
7+
---
8+
9+
10+
<!-- Please do not edit this file, it is generated. -->
11+
# Ephemeral: tfe_outputs
12+
13+
This ephemeral resource is used to retrieve the state outputs for a given workspace.
14+
It enables output values in one Terraform configuration to be used in another.
15+
The retrieved output values are guaranteed not to be written to state.
16+
17+
~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral).
18+
19+
---
20+
21+
~> **NOTE:** Regardless of the sensitivity of the output values as set in HCP
22+
Terraform, the `values` and `nonsensitive_values` attributes in this ephemeral
23+
resource are both treated as sensitive.
24+
25+
## Example Usage
26+
27+
Using the `tfe_outputs` ephemeral resource, the outputs `vault_role_id` and `vault_secret_id` can be used to configure a vault provider instance as seen below:
28+
29+
In the example below, assume we have outputs defined in a `my-org/my-workspace`:
30+
31+
```python
32+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
33+
from constructs import Construct
34+
from cdktf import TerraformStack
35+
#
36+
# Provider bindings are generated by running `cdktf get`.
37+
# See https://cdk.tf/provider-generation for more details.
38+
#
39+
from imports.vault.provider import VaultProvider
40+
class MyConvertedCode(TerraformStack):
41+
def __init__(self, scope, name):
42+
super().__init__(scope, name)
43+
# The following providers are missing schema information and might need manual adjustments to synthesize correctly: vault.
44+
# For a more precise conversion please use the --provider flag in convert.
45+
VaultProvider(self, "vault",
46+
auth_login=[{
47+
"parameters": [{
48+
"role_id": foo.values.vault_role_id,
49+
"secret_id": foo.values.vault_secret_id
50+
}
51+
],
52+
"path": "auth/approle/login"
53+
}
54+
]
55+
)
56+
```
57+
58+
## Argument Reference
59+
60+
The following arguments are supported:
61+
62+
* `organization` - (Optional) The name of the organization. If omitted, the
63+
organization must be defined in the provider config.
64+
* `workspace` - (Required) The name of the workspace.
65+
66+
## Attributes Reference
67+
68+
The following attributes are exported:
69+
70+
* `values` - The current output values for the specified workspace.
71+
* `nonsensitive_values` - The current non-sensitive output values for the specified workspace, this is a subset of all output values.
72+
73+
<!-- cache-key: cdktf-0.20.8 input-25868a462b51b850499a9e695e33687f8cb610c5427b2aba1ca0998eac2049fc -->

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,11 @@ The following arguments are supported:
163163
if `destination_type` is `generic`, `microsoft-teams`, or `slack`.
164164
* `enabled` - (Optional) Whether the notification configuration should be enabled or not.
165165
Disabled configurations will not send any notifications. Defaults to `false`.
166-
* `token` - (Optional) A write-only secure token for the notification configuration, which can
166+
* `token` - (Optional) A token for the notification configuration, which can
167+
be used by the receiving server to verify request authenticity when configured for notification
168+
configurations with a destination type of `generic`. Defaults to `null`.
169+
This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
170+
* `token_wo` - (Optional) Write-only secure token for the notification configuration, which can
167171
be used by the receiving server to verify request authenticity when configured for notification
168172
configurations with a destination type of `generic`. Defaults to `null`.
169173
This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
@@ -176,6 +180,8 @@ The following arguments are supported:
176180
is `email`.
177181
* `workspace_id` - (Required) The id of the workspace that owns the notification configuration.
178182

183+
-> **Note:** Write-Only argument `token_wo` is available to use in place of `token`. 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).
184+
179185
## Attributes Reference
180186

181187
* `id` - The ID of the notification configuration.
@@ -188,4 +194,4 @@ Notification configurations can be imported; use `<NOTIFICATION CONFIGURATION ID
188194
terraform import tfe_notification_configuration.test nc-qV9JnKRkmtMa4zcA
189195
```
190196

191-
<!-- cache-key: cdktf-0.20.8 input-710b7782960f76dfa6c0cc90313ce4411ea1070e9620f03dafea7305849d1d27 -->
197+
<!-- cache-key: cdktf-0.20.8 input-602abbb3e61f8ee1ab3e37f93f617a0ee9bd51107cba5e96e1c93dcbcc40147c -->

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The following arguments are supported:
4646
* `enabled` - (Optional) Whether the task will be run.
4747
* `description` - (Optional) A short description of the the task.
4848
* `hmac_key` - (Optional) HMAC key to verify run task.
49+
* `hmac_key_wo` - (Optional) Write-only HMAC key to verify run task.
4950
* `name` - (Required) Name of the task.
5051
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
5152
* `url` - (Required) URL to send a run task payload.
@@ -63,4 +64,4 @@ import ID. For example:
6364
terraform import tfe_organization_run_task.test my-org-name/task-name
6465
```
6566
-> **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 -->
67+
<!-- cache-key: cdktf-0.20.8 input-afc530d14013df0095835e1f25d6d21eb46d0fa97edd04013a3cc98fb8fd84b2 -->

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ The following arguments are supported:
5454

5555
* `key` - (Required) Name of the parameter.
5656
* `value` - (Required) Value of the parameter.
57+
* `value_wo` - (Required) Write-only value of the parameter.
5758
* `sensitive` - (Optional) Whether the value is sensitive. If true then the
5859
parameter is written once and not visible thereafter. Defaults to `false`.
5960
* `policy_set_id` - (Required) The ID of the policy set that owns the parameter.
@@ -74,4 +75,4 @@ terraform import tfe_policy_set_parameter.test polset-wAs3zYmWAhYK7peR/var-5rTwn
7475

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

77-
<!-- cache-key: cdktf-0.20.8 input-187122d94383c3f0a1bf8f37a537c91855fb7d3649f9b9c5384c4261bf4b184a -->
78+
<!-- cache-key: cdktf-0.20.8 input-9407d3e4f2059d5e47f2ca6b48d9903b45579e73fff781c0b7d5871a0378b553 -->

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,12 @@ The following arguments are supported:
5757
* `sso_api_token_session_timeout` - (Optional) Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
5858
* `certificate` - (Optional) The certificate used for request and assertion signing.
5959
* `private_key` - (Optional) The private key used for request and assertion signing.
60+
* `private_key_wo` - (Optional) The private key used for request and assertion signing, guaranteed not to be written to plan or state artifacts. One of `private_key` or `private_key_wo` must be provided.
6061
* `signature_signing_method` - (Optional) Signature Signing Method. Must be either `SHA1` or `SHA256`. Defaults to `SHA256`.
6162
* `signature_digest_method` - (Optional) Signature Digest Method. Must be either `SHA1` or `SHA256`. Defaults to `SHA256`.
6263

64+
-> **Note:** Write-Only argument `private_key_wo` is available to use in place of `private_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).
65+
6366
## Attributes Reference
6467

6568
* `id` - The ID of the SAML Settings. Always `saml`.
@@ -75,4 +78,4 @@ SAML Settings can be imported.
7578
terraform import tfe_saml_settings.this saml
7679
```
7780

78-
<!-- cache-key: cdktf-0.20.8 input-638ff2b3454a9c98199c9259ef06e339ead03786f80128a77130cb8fde31700e -->
81+
<!-- cache-key: cdktf-0.20.8 input-5fa9d70e545ec380df377f78bd03d35417ec9718041b71cd9f817ee3691f3141 -->

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@ The following arguments are supported:
4141

4242
* `name` - (Required) Name to identify the SSH key.
4343
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
44-
* `key` - (Required) The text of the SSH private key.
44+
* `key` - (Optional) The text of the SSH private key. One of `key` or `key_wo`
45+
must be provided.
46+
* `key_wo` - (Optional) The text of the SSH private key, guaranteed not to be
47+
written to plan or state artifacts. One of `key` or `key_wo` must be provided.
4548

4649
## Attributes Reference
4750

@@ -52,4 +55,6 @@ The following arguments are supported:
5255
Because the Terraform Enterprise API does not return the private SSH key
5356
content, this resource cannot be imported.
5457

55-
<!-- cache-key: cdktf-0.20.8 input-ee94b4fd069224353c99784ca57ae132bbda89fc744065f36044f8e8c8a1f9b0 -->
58+
-> **Note:** Write-Only argument `key_wo` is available to use in place of `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).
59+
60+
<!-- cache-key: cdktf-0.20.8 input-8fd63e504edbedc2b128309474372aca9db27ddff986cf877d21ca65edf3fe4b -->

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ The following arguments are supported:
185185
be used by the receiving server to verify request authenticity when configured for notification
186186
configurations with a destination type of `generic`. Defaults to `null`.
187187
This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
188+
- `token_wo` - (Optional) A write-only secure token for the notification configuration, guaranteed not to be written to plan or state artifacts. Only one of `token` or `token_wo` can be provided.
188189
- `triggers` - (Optional) The array of triggers for which this notification configuration will
189190
send notifications. Currently, the only valid value is `change_request:created`.
190191

@@ -199,5 +200,5 @@ Team notification configurations can be imported; use `<NOTIFICATION CONFIGURATI
199200
```shell
200201
terraform import tfe_team_notification_configuration.test nc-qV9JnKRkmtMa4zcA
201202
```
202-
203-
<!-- cache-key: cdktf-0.20.8 input-e19a07b2d6595b58e8595b5ac25d781ff68c58ce67d0af5d239cd0cd444484fa -->
203+
> **Note:** Write-Only argument `token_wo` is available to use in place of `token_wo`. 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).
204+
<!-- cache-key: cdktf-0.20.8 input-b2a07a1fcbfa0a13f76e1177f498fa32de3fbd78dafdb389af241667cee464bb -->

website/docs/cdktf/typescript/d/ssh_key.html.markdown

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,13 @@ class MyConvertedCode extends TerraformStack {
3939
The following arguments are supported:
4040

4141
* `name` - (Required) Name of the SSH key.
42-
* `organization` - (Required) Name of the organization.
42+
* `organization` - (Optional) Name of the organization. If omitted, organization
43+
must be defined in the provider config.
4344

4445
## Attributes Reference
4546

4647
In addition to all arguments above, the following attributes are exported:
4748

4849
* `id` - The ID of the SSH key.
4950

50-
<!-- cache-key: cdktf-0.20.8 input-806b3725b385ea145f9913c0e0d9cd7b045ae9faf7bb22bbddfa40eda1fb10e3 -->
51+
<!-- cache-key: cdktf-0.20.8 input-eb29ed64f702678fe5f4e16b19cee416f189775eb585e2b64df226614d29f489 -->

0 commit comments

Comments
 (0)