Skip to content

Commit 3488db1

Browse files
team-tf-cdkctrombley
authored andcommitted
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_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
1 parent 59a730b commit 3488db1

File tree

2 files changed

+40
-14
lines changed

2 files changed

+40
-14
lines changed

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

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ description: |-
99
<!-- Please do not edit this file, it is generated. -->
1010
# tfe_team_token
1111

12-
Generates a new team token and overrides existing token if one exists.
12+
Generates a new team token. If a description is not set, then it follows the legacy behavior to override
13+
the single team token without a description if it exists.
1314

1415
## Example Usage
1516

@@ -32,7 +33,12 @@ class MyConvertedCode(TerraformStack):
3233
name="my-team-name",
3334
organization="my-org-name"
3435
)
35-
tfe_team_token_test = TeamToken(self, "test_1",
36+
TeamToken(self, "ci",
37+
description="my second team token",
38+
team_id=test.id
39+
)
40+
tfe_team_token_test = TeamToken(self, "test_2",
41+
description="my team token",
3642
team_id=test.id
3743
)
3844
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.
@@ -44,12 +50,14 @@ class MyConvertedCode(TerraformStack):
4450
The following arguments are supported:
4551

4652
* `team_id` - (Required) ID of the team.
47-
* `force_regenerate` - (Optional) If set to `true`, a new token will be
48-
generated even if a token already exists. This will invalidate the existing
49-
token!
53+
* `description` - (Optional) The token's description, which must be unique per team. Required if creating multiple
54+
tokens for a single team.
5055
* `expired_at` - (Optional) The token's expiration date. The expiration date must be a date/time string in RFC3339
5156
format (e.g., "2024-12-31T23:59:59Z"). If no expiration date is supplied, the expiration date will default to null and
5257
never expire.
58+
* `force_regenerate` - (Optional) Only applies to legacy tokens without descriptions. If set to `true`, a new
59+
token will be generated even if a token already exists. This will invalidate the existing token! This cannot
60+
be set with `description`.
5361

5462
## Example Usage
5563

@@ -79,6 +87,7 @@ class MyConvertedCode(TerraformStack):
7987
rotation_days=30
8088
)
8189
tfe_team_token_test = TeamToken(self, "test_2",
90+
description="my team token",
8291
expired_at=Token.as_string(example.rotation_rfc3339),
8392
team_id=test.id
8493
)
@@ -93,10 +102,14 @@ class MyConvertedCode(TerraformStack):
93102

94103
## Import
95104

96-
Team tokens can be imported; use `<TEAM ID>` as the import ID. For example:
105+
Team tokens can be imported either by `<TOKEN ID>` or by `<TEAM ID>`. Using the team ID will follow the
106+
legacy behavior where the imported token is the single token of the team that has no description.
107+
108+
For example:
97109

98110
```shell
111+
terraform import tfe_team_token.test at-47qC3LmA47piVan7
99112
terraform import tfe_team_token.test team-47qC3LmA47piVan7
100113
```
101114

102-
<!-- cache-key: cdktf-0.20.8 input-81ad21e38f7d39a442070952309741b9fc85572d00ada484fd6850ada6613dff -->
115+
<!-- cache-key: cdktf-0.20.8 input-292898c6eaed44c7a5d55942b397c8db6d933d9f88e258bb804dbd6e2a77157c -->

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

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ description: |-
99
<!-- Please do not edit this file, it is generated. -->
1010
# tfe_team_token
1111

12-
Generates a new team token and overrides existing token if one exists.
12+
Generates a new team token. If a description is not set, then it follows the legacy behavior to override
13+
the single team token without a description if it exists.
1314

1415
## Example Usage
1516

@@ -32,7 +33,12 @@ class MyConvertedCode extends TerraformStack {
3233
name: "my-team-name",
3334
organization: "my-org-name",
3435
});
35-
const tfeTeamTokenTest = new TeamToken(this, "test_1", {
36+
new TeamToken(this, "ci", {
37+
description: "my second team token",
38+
teamId: test.id,
39+
});
40+
const tfeTeamTokenTest = new TeamToken(this, "test_2", {
41+
description: "my team token",
3642
teamId: test.id,
3743
});
3844
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
@@ -47,12 +53,14 @@ class MyConvertedCode extends TerraformStack {
4753
The following arguments are supported:
4854

4955
* `teamId` - (Required) ID of the team.
50-
* `forceRegenerate` - (Optional) If set to `true`, a new token will be
51-
generated even if a token already exists. This will invalidate the existing
52-
token!
56+
* `description` - (Optional) The token's description, which must be unique per team. Required if creating multiple
57+
tokens for a single team.
5358
* `expiredAt` - (Optional) The token's expiration date. The expiration date must be a date/time string in RFC3339
5459
format (e.g., "2024-12-31T23:59:59Z"). If no expiration date is supplied, the expiration date will default to null and
5560
never expire.
61+
* `forceRegenerate` - (Optional) Only applies to legacy tokens without descriptions. If set to `true`, a new
62+
token will be generated even if a token already exists. This will invalidate the existing token! This cannot
63+
be set with `description`.
5664

5765
## Example Usage
5866

@@ -82,6 +90,7 @@ class MyConvertedCode extends TerraformStack {
8290
rotation_days: 30,
8391
});
8492
const tfeTeamTokenTest = new TeamToken(this, "test_2", {
93+
description: "my team token",
8594
expiredAt: Token.asString(example.rotationRfc3339),
8695
teamId: test.id,
8796
});
@@ -99,10 +108,14 @@ class MyConvertedCode extends TerraformStack {
99108

100109
## Import
101110

102-
Team tokens can be imported; use `<TEAM ID>` as the import ID. For example:
111+
Team tokens can be imported either by `<TOKEN ID>` or by `<TEAM ID>`. Using the team ID will follow the
112+
legacy behavior where the imported token is the single token of the team that has no description.
113+
114+
For example:
103115

104116
```shell
117+
terraform import tfe_team_token.test at-47qC3LmA47piVan7
105118
terraform import tfe_team_token.test team-47qC3LmA47piVan7
106119
```
107120

108-
<!-- cache-key: cdktf-0.20.8 input-81ad21e38f7d39a442070952309741b9fc85572d00ada484fd6850ada6613dff -->
121+
<!-- cache-key: cdktf-0.20.8 input-292898c6eaed44c7a5d55942b397c8db6d933d9f88e258bb804dbd6e2a77157c -->

0 commit comments

Comments
 (0)