Skip to content

Commit 730d6a7

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,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_module.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 (#1777)
1 parent b153a69 commit 730d6a7

26 files changed

+317
-128
lines changed

website/docs/cdktf/python/ephemeral-resources/team_token.html.markdown

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@
22
layout: "tfe"
33
page_title: "Terraform Enterprise: Ephemeral: tfe_team_token"
44
description: |-
5-
Generates a new team token that is guaranteed not to be written to
6-
state.
5+
Generates an ephemeral team token.
76
---
87

98

109
<!-- Please do not edit this file, it is generated. -->
1110
# Ephemeral: tfe_team_token
1211

13-
Terraform ephemeral resource for managing a TFE team token. This
14-
resource is used to generate a new team token that is guaranteed not to
15-
be written to state. Since team tokens are singleton resources, using this ephemeral resource will replace any existing team token for a given team.
12+
Generates an ephemeral team token for use during a Terraform run.
13+
14+
Ephemeral team tokens are only valid within the context of a single run, and
15+
are not stored in Terraform state.
16+
17+
Ephemeral resources are provisioned during the plan phase of a run as well as
18+
the apply phase.
19+
20+
If you need the team token to remain valid for long-lived use, consider using the
21+
`tfe_team_token` managed resource instead.
1622

1723
~> **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).
1824

@@ -57,4 +63,4 @@ This ephemeral resource exports the following attributes in addition to the argu
5763
* `token` - The generated token. This value is sensitive and will not be stored
5864
in state.
5965

60-
<!-- cache-key: cdktf-0.20.8 input-7fb01a6dc5b51ba75a5b6999da4581efd4284ddd49dccc9781612f2a6883c6a0 -->
66+
<!-- cache-key: cdktf-0.20.8 input-392968ac0f012ea80837f8853f23ad92cb0723053dd23744b461934c5de20dd9 -->

website/docs/cdktf/python/index.html.markdown

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010
# HCP Terraform and Terraform Enterprise Provider
1111

1212
This provider is used to interact with the many resources supported by
13-
[HCP Terraform](/docs/cloud/index.html). As [Terraform
13+
[HCP Terraform](/docs/cloud/index.html). As [Terraform
1414
Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of
1515
HCP Terraform, this provider supports both Cloud and Enterprise.
1616

@@ -32,7 +32,7 @@ token](/docs/cloud/users-teams-organizations/api-tokens.html) from an account
3232
with appropriate permissions. This user should belong to the "owners" team of
3333
every organization you wish to manage. Alternatively, you can use [an organization or team
3434
token](/docs/cloud/users-teams-organizations/api-tokens.html) instead of a user
35-
token, but it will limit which resources you can manage. Organization and team
35+
token, but it will limit which resources you can manage. Organization and team
3636
tokens cannot manage resources across multiple organizations, and organization
3737
tokens cannot manage certain resource types (like SSH keys). See the [API token
3838
documentation](/docs/cloud/users-teams-organizations/api-tokens.html#access-levels)
@@ -41,10 +41,10 @@ for more details about access to specific resources.
4141
There are several ways to provide the required token:
4242

4343
- **Set the `token` argument in the provider configuration.** You can set
44-
the `token` argument in the provider configuration. Use an input variable for
45-
the token.
44+
the `token` argument in the provider configuration. Use an input variable for
45+
the token.
4646
- **Set the `TFE_TOKEN` environment variable:** The provider can read the
47-
`TFE_TOKEN` environment variable and the token stored there to authenticate.
47+
`TFE_TOKEN` environment variable and the token stored there to authenticate.
4848

4949
When configuring the input variable for either of these options, mark them as sensitive.
5050

@@ -58,14 +58,13 @@ If you are using this provider on your local command line without remote operati
5858
are two more options available to you:
5959

6060
- **Use `terraform login` to generate credentials:** When using this provider with
61-
Terraform on your local command line, it can automatically discover the credentials generated by
62-
[`terraform login`](https://developer.hashicorp.com/terraform/cli/commands/login).
61+
Terraform on your local command line, it can automatically discover the credentials generated by
62+
[`terraform login`](https://developer.hashicorp.com/terraform/cli/commands/login).
6363
- **Set a `credentials` block in your CLI config file (.terraformrc):** See
64-
the [CLI Configuration File documentation](/docs/commands/cli-config.html).
65-
If you used the `TF_CLI_CONFIG_FILE` environment variable to specify a
66-
non-default location for .terraformrc, the provider will also use that location.
67-
Using a `credentials_helper` block is not supported.
68-
64+
the [CLI Configuration File documentation](/docs/commands/cli-config.html).
65+
If you used the `TF_CLI_CONFIG_FILE` environment variable to specify a
66+
non-default location for .terraformrc, the provider will also use that location.
67+
Using a `credentials_helper` block is not supported.
6968

7069
## Versions
7170

@@ -89,7 +88,7 @@ The above snippet using `required_providers` is for Terraform 0.13+; if you are
8988

9089
```hcl
9190
provider "tfe" {
92-
version = "~> 0.64.0"
91+
version = "~> 0.67.1"
9392
...
9493
}
9594
```
@@ -125,17 +124,17 @@ class MyConvertedCode(TerraformStack):
125124

126125
The following arguments are supported:
127126

128-
* `hostname` - (Optional) The HCP Terraform or Terraform Enterprise hostname to connect to.
127+
- `hostname` - (Optional) The HCP Terraform or Terraform Enterprise hostname to connect to.
129128
Defaults to `app.terraform.io`. Can be overridden by setting the
130129
`TFE_HOSTNAME` environment variable.
131-
* `token` - (Optional) The token used to authenticate with HCP Terraform or Terraform Enterprise.
130+
- `token` - (Optional) The token used to authenticate with HCP Terraform or Terraform Enterprise.
132131
See [Authentication](#authentication) above for more information.
133-
* `ssl_skip_verify` - (Optional) Whether or not to skip certificate verifications.
132+
- `ssl_skip_verify` - (Optional) Whether or not to skip certificate verifications.
134133
Defaults to `false`. Can be overridden setting the `TFE_SSL_SKIP_VERIFY`
135134
environment variable.
136-
* `organization` - (Optional) The default organization that resources should
135+
- `organization` - (Optional) The default organization that resources should
137136
belong to. If provided, it's usually possible to omit resource-specific `organization`
138137
arguments. Ensure that the organization already exists prior to using this argument.
139138
This can also be specified using the `TFE_ORGANIZATION` environment variable.
140139

141-
<!-- cache-key: cdktf-0.20.8 input-05486c7d4c175286118a02a92524efe52d7b89a7fe28678c16f1950704e3650b -->
140+
<!-- cache-key: cdktf-0.20.8 input-a4528fac3136fd1ca80fe48358dfb8ad565e80df9b4ece24df86ee2def3f2649 -->

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,7 @@ The following arguments are supported:
167167
be used by the receiving server to verify request authenticity when configured for notification
168168
configurations with a destination type of `generic`. Defaults to `null`.
169169
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
171-
be used by the receiving server to verify request authenticity when configured for notification
172-
configurations with a destination type of `generic`. Defaults to `null`.
173-
This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
170+
* `token_wo` - (Optional, [Write-Only](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments)) Write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of `generic`. Either `token` or `token_wo` can be provided, but not both. This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
174171
* `triggers` - (Optional) The array of triggers for which this notification configuration will
175172
send notifications. Valid values are `run:created`, `run:planning`, `run:needs_attention`, `run:applying`
176173
`run:completed`, `run:errored`, `assessment:check_failure`, `assessment:drifted`, `assessment:failed`, `workspace:auto_destroy_reminder`, or `workspace:auto_destroy_run_results`.
@@ -194,4 +191,4 @@ Notification configurations can be imported; use `<NOTIFICATION CONFIGURATION ID
194191
terraform import tfe_notification_configuration.test nc-qV9JnKRkmtMa4zcA
195192
```
196193

197-
<!-- cache-key: cdktf-0.20.8 input-602abbb3e61f8ee1ab3e37f93f617a0ee9bd51107cba5e96e1c93dcbcc40147c -->
194+
<!-- cache-key: cdktf-0.20.8 input-dd61ff105262594a5f42b23b50aeca147747e8946666c3d76f526b8351b6cfb6 -->

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ 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.
49+
* `hmac_key_wo` - (Optional, [Write-Only](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments)) Write-only HMAC key to verify run task. Either `hmac_key` or `hmac_key_wo` can be provided, but not both.
50+
5051
* `name` - (Required) Name of the task.
5152
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
5253
* `url` - (Required) URL to send a run task payload.
@@ -64,4 +65,5 @@ import ID. For example:
6465
terraform import tfe_organization_run_task.test my-org-name/task-name
6566
```
6667
-> **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).
67-
<!-- cache-key: cdktf-0.20.8 input-afc530d14013df0095835e1f25d6d21eb46d0fa97edd04013a3cc98fb8fd84b2 -->
68+
69+
<!-- cache-key: cdktf-0.20.8 input-039df03871d723a66050b1f719515044bcfb16941fe4b297d4ad11281a34813b -->

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ 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.
57+
* `value_wo` - (Optional, [Write-Only](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments)) Write-only value of the parameter. Either `value` or `value_wo` can be provided, but not both.
58+
5859
* `sensitive` - (Optional) Whether the value is sensitive. If true then the
5960
parameter is written once and not visible thereafter. Defaults to `false`.
6061
* `policy_set_id` - (Required) The ID of the policy set that owns the parameter.
@@ -75,4 +76,4 @@ terraform import tfe_policy_set_parameter.test polset-wAs3zYmWAhYK7peR/var-5rTwn
7576

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

78-
<!-- cache-key: cdktf-0.20.8 input-9407d3e4f2059d5e47f2ca6b48d9903b45579e73fff781c0b7d5871a0378b553 -->
79+
<!-- cache-key: cdktf-0.20.8 input-42fcb606484d85e415494f572d486c767045f2bc11f03fe7b36dccb6b4ea0564 -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ 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.
60+
* `private_key_wo` - (Optional, [Write-Only](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments)) The private key used for request and assertion signing, guaranteed not to be written to plan or state artifacts. Either `private_key` or `private_key_wo` can be provided, but not both.
6161
* `signature_signing_method` - (Optional) Signature Signing Method. Must be either `SHA1` or `SHA256`. Defaults to `SHA256`.
6262
* `signature_digest_method` - (Optional) Signature Digest Method. Must be either `SHA1` or `SHA256`. Defaults to `SHA256`.
6363

@@ -78,4 +78,4 @@ SAML Settings can be imported.
7878
terraform import tfe_saml_settings.this saml
7979
```
8080

81-
<!-- cache-key: cdktf-0.20.8 input-5fa9d70e545ec380df377f78bd03d35417ec9718041b71cd9f817ee3691f3141 -->
81+
<!-- cache-key: cdktf-0.20.8 input-6e71321b8aa7612361601347f5216bf83460d5273c1f8d934c06f7a6925258da -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The following arguments are supported:
4343
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
4444
* `key` - (Optional) The text of the SSH private key. One of `key` or `key_wo`
4545
must be provided.
46-
* `key_wo` - (Optional) The text of the SSH private key, guaranteed not to be
46+
* `key_wo` - (Optional, [Write-Only](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments)) The text of the SSH private key, guaranteed not to be
4747
written to plan or state artifacts. One of `key` or `key_wo` must be provided.
4848

4949
## Attributes Reference
@@ -57,4 +57,4 @@ content, this resource cannot be imported.
5757

5858
-> **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).
5959

60-
<!-- cache-key: cdktf-0.20.8 input-8fd63e504edbedc2b128309474372aca9db27ddff986cf877d21ca65edf3fe4b -->
60+
<!-- cache-key: cdktf-0.20.8 input-4145429fa09f70dcbd1e53bbbe9cacef09123cd081cf03a8b4a30f26615f87e5 -->

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

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Defines a Stack resource.
1515

1616
## Example Usage
1717

18-
Basic usage:
18+
### Create a stack with a VCS repository:
1919

2020
```python
2121
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
@@ -54,13 +54,47 @@ class MyConvertedCode(TerraformStack):
5454
)
5555
```
5656

57+
### Create a stack without a VCS repository:
58+
59+
```python
60+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
61+
from constructs import Construct
62+
from cdktf import Token, TerraformStack
63+
#
64+
# Provider bindings are generated by running `cdktf get`.
65+
# See https://cdk.tf/provider-generation for more details.
66+
#
67+
from imports.tfe.data_tfe_organization import DataTfeOrganization
68+
from imports.tfe.oauth_client import OauthClient
69+
from imports.tfe.stack import Stack
70+
class MyConvertedCode(TerraformStack):
71+
def __init__(self, scope, name):
72+
super().__init__(scope, name)
73+
OauthClient(self, "test",
74+
api_url="https://api.github.com",
75+
http_url="https://github.com",
76+
oauth_token=github_token.string_value,
77+
organization="my-example-org",
78+
service_provider="github"
79+
)
80+
organization = DataTfeOrganization(self, "organization",
81+
name="my-example-org"
82+
)
83+
Stack(self, "test-stack",
84+
description="A Terraform Stack using two components with two environments",
85+
name="my-stack",
86+
project_id=Token.as_string(organization.default_project_id)
87+
)
88+
```
89+
90+
5791
## Argument Reference
5892

5993
The following arguments are supported:
6094

6195
* `name` - (Required) Name of the stack.
6296
* `project_id` - (Required) ID of the project where the stack should be created.
63-
* `vcs_repo` - (Required) Settings for the stack's VCS repository.
97+
* `vcs_repo` - (Optional) Settings for the stack's VCS repository.
6498
* `description` - (Optional) Description of the stack
6599
<!--
66100
NOTE: This is a proposed schema for allowing force-delete actions on a stack. Force delete is not implemented yet so I've commented it out for now.
@@ -89,4 +123,4 @@ Example:
89123
terraform import tfe_stack.test-stack st-9cs9Vf6Z49Zzrk1t
90124
```
91125

92-
<!-- cache-key: cdktf-0.20.8 input-647b86834df95c1c357e66862aa1ce8a7f6e71374728ea1ad8fd13f979f2709f -->
126+
<!-- cache-key: cdktf-0.20.8 input-72b2f6d4e6727f7bf9f716fd0b103d8c72dc93adf23466fbde49e96ec659d5ee -->

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,8 @@ The following arguments are supported:
181181
if `destination_type` is `generic`, `microsoft-teams`, or `slack`.
182182
- `enabled` - (Optional) Whether the notification configuration should be enabled or not.
183183
Disabled configurations will not send any notifications. Defaults to `false`.
184-
- `token` - (Optional) A write-only secure token for the notification configuration, which can
185-
be used by the receiving server to verify request authenticity when configured for notification
186-
configurations with a destination type of `generic`. Defaults to `null`.
187-
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.
184+
- `token` - (Optional) A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of `generic`. Defaults to `null`. This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
185+
- `token_wo` - (Optional, [Write-Only](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments)) A write-only secure token for the notification configuration, guaranteed not to be written to plan or state artifacts. Either `token` or `token_wo` can be provided, but not both. This value _must not_ be provided if `destination_type` is `email`, `microsoft-teams`, or `slack`.
189186
- `triggers` - (Optional) The array of triggers for which this notification configuration will
190187
send notifications. Currently, the only valid value is `change_request:created`.
191188

@@ -201,4 +198,5 @@ Team notification configurations can be imported; use `<NOTIFICATION CONFIGURATI
201198
terraform import tfe_team_notification_configuration.test nc-qV9JnKRkmtMa4zcA
202199
```
203200
> **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 -->
201+
202+
<!-- cache-key: cdktf-0.20.8 input-7fba13f400a07acdbcb49ea8aa42298d53429f96ca00c2dbe68dfb3a55dfdfd6 -->

0 commit comments

Comments
 (0)