You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generates a new team token that is guaranteed not to be written to
6
-
state.
5
+
Generates an ephemeral team token.
7
6
---
8
7
9
8
10
9
<!-- Please do not edit this file, it is generated. -->
11
10
# Ephemeral: tfe_team_token
12
11
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.
16
22
17
23
~> **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
24
@@ -57,4 +63,4 @@ This ephemeral resource exports the following attributes in addition to the argu
57
63
*`token` - The generated token. This value is sensitive and will not be stored
Copy file name to clipboardExpand all lines: website/docs/cdktf/python/r/notification_configuration.html.markdown
+2-5Lines changed: 2 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,10 +167,7 @@ The following arguments are supported:
167
167
be used by the receiving server to verify request authenticity when configured for notification
168
168
configurations with a destination type of `generic`. Defaults to `null`.
169
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
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`.
174
171
*`triggers` - (Optional) The array of triggers for which this notification configuration will
175
172
send notifications. Valid values are `run:created`, `run:planning`, `run:needs_attention`, `run:applying`
176
173
`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
Copy file name to clipboardExpand all lines: website/docs/cdktf/python/r/organization_run_task.html.markdown
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,8 @@ The following arguments are supported:
46
46
*`enabled` - (Optional) Whether the task will be run.
47
47
*`description` - (Optional) A short description of the the task.
48
48
*`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
+
50
51
*`name` - (Required) Name of the task.
51
52
*`organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
52
53
*`url` - (Required) URL to send a run task payload.
-> **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).
Copy file name to clipboardExpand all lines: website/docs/cdktf/python/r/policy_set_parameter.html.markdown
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,8 @@ The following arguments are supported:
54
54
55
55
*`key` - (Required) Name of the parameter.
56
56
*`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
+
58
59
*`sensitive` - (Optional) Whether the value is sensitive. If true then the
59
60
parameter is written once and not visible thereafter. Defaults to `false`.
60
61
*`policy_set_id` - (Required) The ID of the policy set that owns the parameter.
-> **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).
Copy file name to clipboardExpand all lines: website/docs/cdktf/python/r/saml_settings.html.markdown
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ The following arguments are supported:
57
57
*`sso_api_token_session_timeout` - (Optional) Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
58
58
*`certificate` - (Optional) The certificate used for request and assertion signing.
59
59
*`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.
61
61
*`signature_signing_method` - (Optional) Signature Signing Method. Must be either `SHA1` or `SHA256`. Defaults to `SHA256`.
62
62
*`signature_digest_method` - (Optional) Signature Digest Method. Must be either `SHA1` or `SHA256`. Defaults to `SHA256`.
Copy file name to clipboardExpand all lines: website/docs/cdktf/python/r/ssh_key.html.markdown
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ The following arguments are supported:
43
43
*`organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
44
44
*`key` - (Optional) The text of the SSH private key. One of `key` or `key_wo`
45
45
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
47
47
written to plan or state artifacts. One of `key` or `key_wo` must be provided.
48
48
49
49
## Attributes Reference
@@ -57,4 +57,4 @@ content, this resource cannot be imported.
57
57
58
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).
Copy file name to clipboardExpand all lines: website/docs/cdktf/python/r/team_notification_configuration.html.markdown
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -181,11 +181,8 @@ The following arguments are supported:
181
181
if `destination_type` is `generic`, `microsoft-teams`, or `slack`.
182
182
-`enabled` - (Optional) Whether the notification configuration should be enabled or not.
183
183
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`.
189
186
-`triggers` - (Optional) The array of triggers for which this notification configuration will
190
187
send notifications. Currently, the only valid value is `change_request:created`.
191
188
@@ -201,4 +198,5 @@ Team notification configurations can be imported; use `<NOTIFICATION CONFIGURATI
> **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).
0 commit comments