Skip to content

Commit 9df5f4b

Browse files
committed
cdktf: update documentation
1 parent ce5b918 commit 9df5f4b

File tree

190 files changed

+1926
-1331
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

190 files changed

+1926
-1331
lines changed

CHANGELOG.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ENHANCEMENTS:
88
* `d/tfe_workspace`: Add an `auto_destroy_at` attribute for reading a scheduled auto-destroy, by @notchairmk [1354](https://github.com/hashicorp/terraform-provider-tfe/pull/1354)
99
* `r/tfe_registry_module`: Add `initial_version` support for Branch Based Modules by @aaabdelgany [#1363](https://github.com/hashicorp/terraform-provider-tfe/pull/1363)
1010
* `r/tfe_oauth_client`: Add `agent_pool_id` as an optional argument to enable Private VCS support, by @roleesinhaHC [1255](https://github.com/hashicorp/terraform-provider-tfe/pull/1255)
11+
* `r/tfe_project`: Increase the Project name length from 36 to 40 characters @hs26gill [#1351](https://github.com/hashicorp/terraform-provider-tfe/pull/1351)
1112

1213
BUG FIXES:
1314
* `r/tfe_registry_module`: Prevents constant diff after a successful apply when `tags` and `tests_enabled` is not set by @Uk1288 [#1357](https://github.com/hashicorp/terraform-provider-tfe/pull/1357)
@@ -17,9 +18,6 @@ BUG FIXES:
1718
FEATURES:
1819
* `r/tfe_team`: Add attributes `manage_teams`, `manage_organization_access`, and `access_secret_teams` to `organization_access` on `tfe_team` by @juliannatetreault [#1313](https://github.com/hashicorp/terraform-provider-tfe/pull/1313)
1920

20-
ENHANCEMENTS:
21-
* `r/tfe_project`: Increase the Project name length from 36 to 40 characters @hs26gill [#1351](https://github.com/hashicorp/terraform-provider-tfe/pull/1351)
22-
2321
## v0.54.0
2422

2523
ENHANCEMENTS:

website/docs/cdktf/csharp/d/ip_ranges.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get HCP Terraform and Terraform Enterprise's IP ranges of its services
66
---
77

8+
9+
<!-- Please do not edit this file, it is generated. -->
810
# Data Source: tfe_ip_ranges
911

1012
Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges).
@@ -43,4 +45,4 @@ The following attributes are exported:
4345
* `Vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers.
4446

4547

46-
<!-- cache-key: cdktf-0.17.0-pre.15 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->
48+
<!-- cache-key: cdktf-0.17.0-pre.15 input-987ff1291f7652480885c8426decd8b28172ee0aede7d6f52322a9845caec7e4 -->

website/docs/cdktf/csharp/d/oauth_client.html.markdown

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on an OAuth client.
66
---
77

8+
9+
<!-- Please do not edit this file, it is generated. -->
810
# Data Source: tfe_oauth_client
911

1012
Use this data source to get information about an OAuth client.
@@ -81,7 +83,7 @@ be set.
8183
* `OauthClientId` - (Optional) ID of the OAuth client.
8284
* `Organization` - (Optional) The name of the organization in which to search.
8385
* `ServiceProvider` - (Optional) The API identifier of the OAuth service provider. If set,
84-
must be one of: `AdoServer`, `AdoServices`,`BitbucketDataCenter`, `BitbucketHosted`, `BitbucketServer`(deprecated),
86+
must be one of: `AdoServer`, `AdoServices`, `BitbucketDataCenter`, `BitbucketHosted`, `BitbucketServer`(deprecated),
8587
`Github`, `GithubEnterprise`, `GitlabHosted`, `GitlabCommunityEdition`, or
8688
`GitlabEnterpriseEdition`.
8789

@@ -99,5 +101,6 @@ In addition to all arguments above, the following attributes are exported:
99101
* `Organization` - The organization in which the OAuth client is registered.
100102
* `ServiceProvider` - The API identifier of the OAuth service provider.
101103
* `ServiceProviderDisplayName` - The display name of the OAuth service provider.
102-
103-
<!-- cache-key: cdktf-0.17.0-pre.15 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->
104+
* `OrganizationScoped` - Whether or not the agent pool can be used by all workspaces and projects in the organization.
105+
* `ProjectIds` - IDs of the projects that use the oauth client.
106+
<!-- cache-key: cdktf-0.17.0-pre.15 input-001f05442f17fd9a94d45188c279515be0f5fbe96f6057ed44a16f3e9be03580 -->

website/docs/cdktf/csharp/d/organization.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ In addition to all arguments above, the following attributes are exported:
4949
* `AggregatedCommitStatusEnabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request.
5050
* `DefaultProjectId` - ID of the organization's default project. All workspaces created without specifying a project ID are created in this project.
5151

52-
<!-- cache-key: cdktf-0.17.0-pre.15 input-944effb44f4d14fb4476a9f26014b95ea0376bb130076243476598735562f471 -->
52+
<!-- cache-key: cdktf-0.17.0-pre.15 input-ef8f010996544db238976f7a2b7dfb50d77204d9275aeacc742c10b942f7c3e6 -->

website/docs/cdktf/csharp/d/organization_membership.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ In addition to all arguments above, the following attributes are exported:
9898
* `UserId` - The ID of the user associated with the organization membership.
9999
* `Username` - The username of the user associated with the organization membership.
100100

101-
<!-- cache-key: cdktf-0.17.0-pre.15 input-d0160d0a09a0b3ce6035db02657e5b320810e469cbd9da4ae71b7158b313258f -->
101+
<!-- cache-key: cdktf-0.17.0-pre.15 input-1069b52dde4b0bd38635c64ace6287da1da5393d94556544ac6f7883ba353f34 -->

website/docs/cdktf/csharp/d/organization_run_task.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on a Run task.
66
---
77

8+
9+
<!-- Please do not edit this file, it is generated. -->
810
# Data Source: tfe_organization_run_task
911

1012
[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization.
@@ -48,4 +50,4 @@ In addition to all arguments above, the following attributes are exported:
4850
* `Id` - The ID of the task.
4951
* `Url` - URL to send a task payload.
5052

51-
<!-- cache-key: cdktf-0.17.0-pre.15 input-7ffa3170dbbf69fd581f515eab6eaac9c5c936b21ba712b8803b32966fbb628c -->
53+
<!-- cache-key: cdktf-0.17.0-pre.15 input-7c767d1de5cd2bd116e2987b91d79ced1dd9d3f95d176929544a3039cfe31dd5 -->

website/docs/cdktf/csharp/d/slug.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ page_title: "Terraform Enterprise: tfe_slug"
44
description: |-
55
Manages files.
66
---
7+
8+
<!-- Please do not edit this file, it is generated. -->
79
# Data Source: tfe_slug
810

911
This data source is used to represent configuration files on a local filesystem
@@ -48,4 +50,4 @@ The following arguments are supported:
4850

4951
* `SourcePath` - (Required) The path to the directory where the files are located.
5052

51-
<!-- cache-key: cdktf-0.17.0-pre.15 input-8546d8f7537661b4b2d4d594c4cb0f6ebd1b0e70ae9e1bcc6e145f33bd763e70 -->
53+
<!-- cache-key: cdktf-0.17.0-pre.15 input-fa2c542204f0df625488e508b9c38200a5fbba730db218a920e6358651a4f10c -->

website/docs/cdktf/csharp/d/workspace.html.markdown

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,8 @@ In addition to all arguments above, the following attributes are exported:
4848
* `AllowDestroyPlan` - Indicates whether destroy plans can be queued on the workspace.
4949
* `AutoApply` - Indicates whether to automatically apply changes when a Terraform plan is successful.
5050
* `AutoApplyRunTrigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace.
51-
<<<<<<< HEAD
51+
* `AutoDestroyAt` - Future date/time string at which point all resources in a workspace will be scheduled to be deleted.
5252
* `AssessmentsEnabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace.
53-
=======
54-
* `AssessmentsEnabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace.
55-
>>>>>>> adf61bce (cdktf: update documentation)
5653
* `FileTriggersEnabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `True`) or always triggered on every push (if `False`).
5754
* `GlobalRemoteState` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `RemoteStateConsumerIds` argument).
5855
* `RemoteStateConsumerIds` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `GlobalRemoteState` is set to `True`.
@@ -92,4 +89,4 @@ The `VcsRepo` block contains:
9289
* `OauthTokenId` - OAuth token ID of the configured VCS connection.
9390
* `TagsRegex` - A regular expression used to trigger a Workspace run for matching Git tags.
9491

95-
<!-- cache-key: cdktf-0.17.0-pre.15 input-82f43ee78054a4a88c04b2768dd5c3b6ba74cdac1de55fecef133b85fe5aee8a -->
92+
<!-- cache-key: cdktf-0.17.0-pre.15 input-7500b2311f3804feb075f040e60989aa8e4fc69cc4ef327b51b7e3ab1f599d6d -->

website/docs/cdktf/csharp/d/workspace_run_task.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on a Workspace Run task.
66
---
77

8+
9+
<!-- Please do not edit this file, it is generated. -->
810
# Data Source: tfe_workspace_task
911

1012
[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization.
@@ -46,4 +48,4 @@ In addition to all arguments above, the following attributes are exported:
4648
* `Id` - The ID of the Workspace Run task.
4749
* `Stage` - Which stage the task will run in.
4850

49-
<!-- cache-key: cdktf-0.17.0-pre.15 input-e44aa1a06a0b5bb16601c13377b266fdc3a847bb3569a6370f46a0120eba6a5c -->
51+
<!-- cache-key: cdktf-0.17.0-pre.15 input-86410a403310625b9c9007c1409553681e71bb1d5dfb652c72477e846011cede -->

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ automatically installed by `terraform init` in the future:
7777
terraform {
7878
required_providers {
7979
tfe = {
80-
version = "~> 0.55.0"
80+
version = "~> 0.56.0"
8181
}
8282
}
8383
}
@@ -90,7 +90,7 @@ The above snippet using `RequiredProviders` is for Terraform 0.13+; if you are u
9090

9191
```hcl
9292
provider "tfe" {
93-
version = "~> 0.55.0"
93+
version = "~> 0.56.0"
9494
...
9595
}
9696
```
@@ -103,7 +103,7 @@ For more information on provider installation and constraining provider versions
103103
provider "tfe" {
104104
hostname = var.hostname # Optional, defaults to HCP Terraform `AppTerraformIo`
105105
token = var.token
106-
version = "~> 0.55.0"
106+
version = "~> 0.56.0"
107107
}
108108
109109
# Create an organization
@@ -116,10 +116,10 @@ resource "tfe_organization" "org" {
116116

117117
The following arguments are supported:
118118

119-
* `Hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to.
119+
* `Hostname` - (Optional) The HCP Terraform or Terraform Enterprise hostname to connect to.
120120
Defaults to `app.terraform.io`. Can be overridden by setting the
121121
`TfeHostname` environment variable.
122-
* `Token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise.
122+
* `Token` - (Optional) The token used to authenticate with HCP Terraform or Terraform Enterprise.
123123
See [Authentication](#authentication) above for more information.
124124
* `SslSkipVerify` - (Optional) Whether or not to skip certificate verifications.
125125
Defaults to `False`. Can be overridden setting the `TfeSslSkipVerify`
@@ -129,4 +129,4 @@ The following arguments are supported:
129129
arguments. Ensure that the organization already exists prior to using this argument.
130130
This can also be specified using the `TfeOrganization` environment variable.
131131

132-
<!-- cache-key: cdktf-0.17.0-pre.15 input-71b632c8101c3bde9d1598273955499b3ab09c1fe1051d376b5fc6c5538335fe -->
132+
<!-- cache-key: cdktf-0.17.0-pre.15 input-d72291151cea8709b729b9dcfb06e9dae682a8cb6e399d427d05e29354451180 -->

0 commit comments

Comments
 (0)