cdktf: update documentation

hashicorp · Jun 13, 2024 · 9df5f4b · 9df5f4b
1 parent ce5b918
commit 9df5f4b
Show file tree

Hide file tree

Showing 190 changed files with 1,926 additions and 1,331 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ ENHANCEMENTS:
 * `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)
 * `r/tfe_registry_module`: Add `initial_version` support for Branch Based Modules by @aaabdelgany [#1363](https://github.com/hashicorp/terraform-provider-tfe/pull/1363)
 * `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)
+* `r/tfe_project`: Increase the Project name length from 36 to 40 characters @hs26gill [#1351](https://github.com/hashicorp/terraform-provider-tfe/pull/1351)
 
 BUG FIXES:
 * `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:
 FEATURES:
 * `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)
 
-ENHANCEMENTS:
-* `r/tfe_project`: Increase the Project name length from 36 to 40 characters @hs26gill [#1351](https://github.com/hashicorp/terraform-provider-tfe/pull/1351)
-
 ## v0.54.0
 
 ENHANCEMENTS:

diff --git a/website/docs/cdktf/csharp/d/ip_ranges.html.markdown b/website/docs/cdktf/csharp/d/ip_ranges.html.markdown
@@ -5,6 +5,8 @@ description: |-
   Get HCP Terraform and Terraform Enterprise's IP ranges of its services
 ---
 
+
+<!-- Please do not edit this file, it is generated. -->
 # Data Source: tfe_ip_ranges
 
 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:
 * `Vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers.
 
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-987ff1291f7652480885c8426decd8b28172ee0aede7d6f52322a9845caec7e4 -->
diff --git a/website/docs/cdktf/csharp/d/oauth_client.html.markdown b/website/docs/cdktf/csharp/d/oauth_client.html.markdown
@@ -5,6 +5,8 @@ description: |-
   Get information on an OAuth client.
 ---
 
+
+<!-- Please do not edit this file, it is generated. -->
 # Data Source: tfe_oauth_client
 
 Use this data source to get information about an OAuth client.
@@ -81,7 +83,7 @@ be set.
 * `OauthClientId` - (Optional) ID of the OAuth client.
 * `Organization` - (Optional) The name of the organization in which to search.
 * `ServiceProvider` - (Optional) The API identifier of the OAuth service provider. If set,
-  must be one of: `AdoServer`, `AdoServices`,`BitbucketDataCenter`, `BitbucketHosted`, `BitbucketServer`(deprecated),
+  must be one of: `AdoServer`, `AdoServices`, `BitbucketDataCenter`,  `BitbucketHosted`, `BitbucketServer`(deprecated),
   `Github`, `GithubEnterprise`, `GitlabHosted`, `GitlabCommunityEdition`, or
   `GitlabEnterpriseEdition`.
 
@@ -99,5 +101,6 @@ In addition to all arguments above, the following attributes are exported:
 * `Organization` - The organization in which the OAuth client is registered.
 * `ServiceProvider` - The API identifier of the OAuth service provider.
 * `ServiceProviderDisplayName` - The display name of the OAuth service provider.
-
-<!-- cache-key: cdktf-0.17.0-pre.15 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->
+* `OrganizationScoped` - Whether or not the agent pool can be used by all workspaces and projects in the organization.
+* `ProjectIds` - IDs of the projects that use the oauth client.
+<!-- cache-key: cdktf-0.17.0-pre.15 input-001f05442f17fd9a94d45188c279515be0f5fbe96f6057ed44a16f3e9be03580 -->
diff --git a/website/docs/cdktf/csharp/d/organization.html.markdown b/website/docs/cdktf/csharp/d/organization.html.markdown
@@ -49,4 +49,4 @@ In addition to all arguments above, the following attributes are exported:
 * `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.
 * `DefaultProjectId` - ID of the organization's default project. All workspaces created without specifying a project ID are created in this project.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-944effb44f4d14fb4476a9f26014b95ea0376bb130076243476598735562f471 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-ef8f010996544db238976f7a2b7dfb50d77204d9275aeacc742c10b942f7c3e6 -->
diff --git a/website/docs/cdktf/csharp/d/organization_membership.html.markdown b/website/docs/cdktf/csharp/d/organization_membership.html.markdown
@@ -98,4 +98,4 @@ In addition to all arguments above, the following attributes are exported:
 * `UserId` - The ID of the user associated with the organization membership.
 * `Username` - The username of the user associated with the organization membership.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-d0160d0a09a0b3ce6035db02657e5b320810e469cbd9da4ae71b7158b313258f -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-1069b52dde4b0bd38635c64ace6287da1da5393d94556544ac6f7883ba353f34 -->
diff --git a/website/docs/cdktf/csharp/d/organization_run_task.html.markdown b/website/docs/cdktf/csharp/d/organization_run_task.html.markdown
@@ -5,6 +5,8 @@ description: |-
   Get information on a Run task.
 ---
 
+
+<!-- Please do not edit this file, it is generated. -->
 # Data Source: tfe_organization_run_task
 
 [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:
 * `Id` - The ID of the task.
 * `Url` - URL to send a task payload.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-7ffa3170dbbf69fd581f515eab6eaac9c5c936b21ba712b8803b32966fbb628c -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-7c767d1de5cd2bd116e2987b91d79ced1dd9d3f95d176929544a3039cfe31dd5 -->
diff --git a/website/docs/cdktf/csharp/d/slug.html.markdown b/website/docs/cdktf/csharp/d/slug.html.markdown
@@ -4,6 +4,8 @@ page_title: "Terraform Enterprise: tfe_slug"
 description: |-
   Manages files.
 ---
+
+<!-- Please do not edit this file, it is generated. -->
 # Data Source: tfe_slug
 
 This data source is used to represent configuration files on a local filesystem
@@ -48,4 +50,4 @@ The following arguments are supported:
 
 * `SourcePath` - (Required) The path to the directory where the files are located.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-8546d8f7537661b4b2d4d594c4cb0f6ebd1b0e70ae9e1bcc6e145f33bd763e70 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-fa2c542204f0df625488e508b9c38200a5fbba730db218a920e6358651a4f10c -->
diff --git a/website/docs/cdktf/csharp/d/workspace.html.markdown b/website/docs/cdktf/csharp/d/workspace.html.markdown
@@ -48,11 +48,8 @@ In addition to all arguments above, the following attributes are exported:
 * `AllowDestroyPlan` - Indicates whether destroy plans can be queued on the workspace.
 * `AutoApply` - Indicates whether to automatically apply changes when a Terraform plan is successful.
 * `AutoApplyRunTrigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace.
-<<<<<<< HEAD
+* `AutoDestroyAt` - Future date/time string at which point all resources in a workspace will be scheduled to be deleted.
 * `AssessmentsEnabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace.
-=======
-* `AssessmentsEnabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace.
->>>>>>> adf61bce (cdktf: update documentation)
 * `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`).
 * `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).
 * `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:
 * `OauthTokenId` - OAuth token ID of the configured VCS connection.
 * `TagsRegex` - A regular expression used to trigger a Workspace run for matching Git tags.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-82f43ee78054a4a88c04b2768dd5c3b6ba74cdac1de55fecef133b85fe5aee8a -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-7500b2311f3804feb075f040e60989aa8e4fc69cc4ef327b51b7e3ab1f599d6d -->
diff --git a/website/docs/cdktf/csharp/d/workspace_run_task.html.markdown b/website/docs/cdktf/csharp/d/workspace_run_task.html.markdown
@@ -5,6 +5,8 @@ description: |-
   Get information on a Workspace Run task.
 ---
 
+
+<!-- Please do not edit this file, it is generated. -->
 # Data Source: tfe_workspace_task
 
 [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:
 * `Id` - The ID of the Workspace Run task.
 * `Stage` - Which stage the task will run in.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-e44aa1a06a0b5bb16601c13377b266fdc3a847bb3569a6370f46a0120eba6a5c -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-86410a403310625b9c9007c1409553681e71bb1d5dfb652c72477e846011cede -->
diff --git a/website/docs/cdktf/csharp/index.html.markdown b/website/docs/cdktf/csharp/index.html.markdown
@@ -77,7 +77,7 @@ automatically installed by `terraform init` in the future:
 terraform {
   required_providers {
     tfe = {
-      version = "~> 0.55.0"
+      version = "~> 0.56.0"
     }
   }
 }
@@ -90,7 +90,7 @@ The above snippet using `RequiredProviders` is for Terraform 0.13+; if you are u
 
 ```hcl
 provider "tfe" {
-  version = "~> 0.55.0"
+  version = "~> 0.56.0"
   ...
 }
 ```
@@ -103,7 +103,7 @@ For more information on provider installation and constraining provider versions
 provider "tfe" {
   hostname = var.hostname # Optional, defaults to HCP Terraform `AppTerraformIo`
   token    = var.token
-  version  = "~> 0.55.0"
+  version  = "~> 0.56.0"
 }
 
 # Create an organization
@@ -116,10 +116,10 @@ resource "tfe_organization" "org" {
 
 The following arguments are supported:
 
-* `Hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to.
+* `Hostname` - (Optional) The HCP Terraform or Terraform Enterprise hostname to connect to.
   Defaults to `app.terraform.io`. Can be overridden by setting the
   `TfeHostname` environment variable.
-* `Token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise.
+* `Token` - (Optional) The token used to authenticate with HCP Terraform or Terraform Enterprise.
   See [Authentication](#authentication) above for more information.
 * `SslSkipVerify` - (Optional) Whether or not to skip certificate verifications.
   Defaults to `False`. Can be overridden setting the `TfeSslSkipVerify`
@@ -129,4 +129,4 @@ The following arguments are supported:
   arguments. Ensure that the organization already exists prior to using this argument.
   This can also be specified using the `TfeOrganization` environment variable.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-71b632c8101c3bde9d1598273955499b3ab09c1fe1051d376b5fc6c5538335fe -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-d72291151cea8709b729b9dcfb06e9dae682a8cb6e399d427d05e29354451180 -->
diff --git a/website/docs/cdktf/csharp/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/cdktf/csharp/r/agent_pool_allowed_workspaces.html.markdown
@@ -19,34 +19,36 @@ for Business account.
 
 In this example, the agent pool and workspace are connected through other resources that manage the agent pool permissions as well as the workspace execution mode. Notice that the `TfeWorkspaceSettings` uses the agent pool reference found in `TfeAgentPoolAllowedWorkspaces` in order to create the permission to use the agent pool before assigning it.
 
-```csharp
-using Constructs;
-using HashiCorp.Cdktf;
-/*Provider bindings are generated by running cdktf get.
-See https://cdk.tf/provider-generation for more details.*/
-using Gen.Providers.Tfe;
-class MyConvertedCode : TerraformStack
-{
-    public MyConvertedCode(Construct scope, string name) : base(scope, name)
-    {
-        var tfeOrganizationTestOrganization = new Organization.Organization(this, "test-organization", new OrganizationConfig {
-            Email = "[email protected]",
-            Name = "my-org-name"
-        });
-        var tfeWorkspaceTestWorkspace = new Workspace.Workspace(this, "test-workspace", new WorkspaceConfig {
-            Name = "my-workspace-name",
-            Organization = Token.AsString(tfeOrganizationTestOrganization.Name)
-        });
-        var tfeAgentPoolTestAgentPool = new AgentPool.AgentPool(this, "test-agent-pool", new AgentPoolConfig {
-            Name = "my-agent-pool-name",
-            Organization = Token.AsString(tfeOrganizationTestOrganization.Name),
-            OrganizationScoped = false
-        });
-        new AgentPoolAllowedWorkspaces.AgentPoolAllowedWorkspaces(this, "test-allowed-workspaces", new AgentPoolAllowedWorkspacesConfig {
-            AgentPoolId = Token.AsString(tfeAgentPoolTestAgentPool.Id),
-            AllowedWorkspaceIds = new [] { Token.AsString(tfeWorkspaceTestWorkspace.Id) }
-        });
-    }
+```hcl
+resource "tfe_organization" "test-organization" {
+  name  = "my-org-name"
+  email = "[email protected]"
+}
+
+// Ensure workspace and agent pool are create first
+resource "tfe_workspace" "test-workspace" {
+  name         = "my-workspace-name"
+  organization = tfe_organization.test-organization.name
+}
+
+resource "tfe_agent_pool" "test-agent-pool" {
+  name                = "my-agent-pool-name"
+  organization        = tfe_organization.test-organization.name
+  organization_scoped = false
+}
+
+// Ensure permissions are assigned second
+resource "tfe_agent_pool_allowed_workspaces" "allowed" {
+  agent_pool_id         = tfe_agent_pool.test-agent-pool.id
+  allowed_workspace_ids = [for key, value in tfe_workspace.test.*.id : value]
+}
+
+// Lastly, ensure the workspace agent execution is assigned last by
+// referencing allowed_workspaces
+resource "tfe_workspace_settings" "test-workspace-settings" {
+  workspace_id   = tfe_workspace.test-workspace.id
+  execution_mode = "agent"
+  agent_pool_id  = tfe_agent_pool_allowed_workspaces.allowed.id
 }
 ```
 
@@ -66,5 +68,4 @@ A resource can be imported; use `<AGENT POOL ID>` as the import ID. For example:
 terraform import tfe_agent_pool_allowed_workspaces.foobar apool-rW0KoLSlnuNb5adB
 ```
 
-
-<!-- cache-key: cdktf-0.17.0-pre.15 input-9d6c804f088514863a2d3b994f35e4cd7e510b8364e61ba1fa41165766b7d693 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-9157c4476b01641ff5f39d382cbf6147fe46fcc8df4d82d12d9452c6388262a7 -->
diff --git a/website/docs/cdktf/csharp/r/agent_token.html.markdown b/website/docs/cdktf/csharp/r/agent_token.html.markdown
@@ -5,6 +5,8 @@ description: |-
   Manages agent tokens
 ---
 
+
+<!-- Please do not edit this file, it is generated. -->
 # tfe_agent_token
 
 Each agent pool has its own set of tokens which are not shared across pools.
@@ -53,4 +55,4 @@ The following arguments are supported:
 * `Description` - The description of agent token.
 * `Token` - The generated token.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-0b48bd828d88ed48d140d96f6cf5b5dd1fd182cfb82d3bf6211f7610464c0f01 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-dfcdb9d5fc8e2c338ad77cb67433ea38039ae0823e53d9454bce150cfff2b576 -->
diff --git a/website/docs/cdktf/csharp/r/notification_configuration.html.markdown b/website/docs/cdktf/csharp/r/notification_configuration.html.markdown
@@ -184,4 +184,4 @@ Notification configurations can be imported; use `<NOTIFICATION CONFIGURATION ID
 terraform import tfe_notification_configuration.test nc-qV9JnKRkmtMa4zcA
 ```
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-9d0816dcd22f4150cde8c310824fc0b8fbead7ab67241d3e7c43d64ea82d47e5 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-51e766a4c44b6ce67b59c3e0006ed5c2511164cb524d4d67da8afdbca5241e7c -->
diff --git a/website/docs/cdktf/csharp/r/oauth_client.html.markdown b/website/docs/cdktf/csharp/r/oauth_client.html.markdown
@@ -5,6 +5,8 @@ description: |-
   Manages OAuth clients.
 ---
 
+
+<!-- Please do not edit this file, it is generated. -->
 # tfe_oauth_client
 
 An OAuth Client represents the connection between an organization and a VCS
@@ -32,6 +34,7 @@ class MyConvertedCode : TerraformStack
             Name = "my-github-oauth-client",
             OauthToken = "my-vcs-provider-token",
             Organization = "my-org-name",
+            OrganizationScoped = true,
             ServiceProvider = "github"
         });
     }
@@ -70,11 +73,11 @@ class MyConvertedCode : TerraformStack
 }
 ```
 
-#### BitBucket Data Center Usage
+#### Bitbucket Data Center Usage
 
-See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-data-center).
+See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server).
 
-When using BitBucket Data Center, you must use three required fields: `Key`, `Secret`, `RsaPublicKey`.
+When using Bitbucket Data Center, you must use three required fields: `Key`, `Secret`, `RsaPublicKey`.
 
 
 ```csharp
@@ -121,20 +124,22 @@ The following arguments are supported:
 * `PrivateKey` - (Required for `AdoServer`) The text of the private key associated with your Azure DevOps Server account
 * `Key` - The OAuth Client key can refer to a Consumer Key, Application Key,
   or another type of client key for the VCS provider.
-* `Secret` - (Required for `BitbucketDataCenter`) The OAuth Client secret is used for BitBucket Data Center, this secret is the
-  the text of the SSH private key associated with your BitBucket Data Center
+* `Secret` - (Required for `BitbucketDataCenter`) The OAuth Client secret is used for Bitbucket Data Center, this secret is the
+  the text of the SSH private key associated with your Bitbucket Data Center
 Application Link.
-* `RsaPublicKey` - (Required for `BitbucketDataCenter`) Required for BitBucket
+* `RsaPublicKey` - (Required for `BitbucketDataCenter`) Required for Bitbucket
   Data Center in conjunction with the secret. Not used for any other providers. The
-text of the SSH public key associated with your BitBucket Data Center Application
+text of the SSH public key associated with your Bitbucket Data Center Application
 Link.
 * `ServiceProvider` - (Required) The VCS provider being connected with. Valid
-  options are `AdoServer`, `AdoServices`, `BitbucketHosted`, `BitbucketDataCenter`, `BitbucketServer`(deprecated), `Github`, `GithubEnterprise`, `GitlabHosted`,
+  options are `AdoServer`, `AdoServices`, `BitbucketDataCenter`, `BitbucketHosted`, `BitbucketServer`(deprecated), `Github`, `GithubEnterprise`, `GitlabHosted`,
   `GitlabCommunityEdition`, or `GitlabEnterpriseEdition`.
+* `AgentPoolId` - (Optional) An existing agent pool ID within the organization that has Private VCS support enabled.
+* `OrganizationScoped` - (Optional) Whether or not the oauth client is scoped to all projects and workspaces in the organization. Defaults to `True`.
 
 ## Attributes Reference
 
 * `Id` - The ID of the OAuth client.
 * `OauthTokenId` - The ID of the OAuth token associated with the OAuth client.
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-0dea494ef76c038939d94b5ae6a0e741e36a87509a350f558cd11d098bf1bde9 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-26be2bcaedcea0e7d49fb518991e7a5f7d59ff32f8b91e689cbbf463768f9804 -->
diff --git a/website/docs/cdktf/csharp/r/opa_version.html.markdown b/website/docs/cdktf/csharp/r/opa_version.html.markdown
@@ -63,6 +63,6 @@ terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr
 terraform import tfe_opa_version.test 0.58.0
 ```
 
--> **Note:** You can fetch a OPA version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-<RANDOM STRING>`
+-> **Note:** You can fetch a OPA version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-<RANDOM STRING>`
 
-<!-- cache-key: cdktf-0.17.0-pre.15 input-1151e0ea0d86797d0c36341e282f903e6350d08f2e7a0bcb8dda931532eabc46 -->
+<!-- cache-key: cdktf-0.17.0-pre.15 input-85ffde68fbb6c7a9dffa29020e669cfcd70100de64e45be334cefb8837e2b8ca -->