Skip to content

Commit 4c66c55

Browse files
authored
cdktf: update documentation (#1253)
* 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 * cdktf: update d/registry_provider.html.markdown,d/registry_gpg_keys.html.markdown,d/registry_gpg_key.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.html.markdown,d/organization_membership.html.markdown * cdktf: update 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.html.markdown * cdktf: update 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_members.html.markdown,r/team_member.html.markdown,r/team_access.html.markdown,r/team.html.markdown,r/ssh_key.html.markdown * cdktf: update 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_installation.html.markdown,d/agent_pool.html.markdown * cdktf: update r/policy_set_parameter.html.markdown,r/policy_set.html.markdown,r/policy.html.markdown,r/organization_token.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
1 parent 3431681 commit 4c66c55

18 files changed

+433
-14
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_no_code_module"
4+
description: |-
5+
Get information on a no-code module.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_provider
11+
12+
Use this data source to read the details of an existing No-Code-Allowed module.
13+
14+
## Example Usage
15+
16+
```python
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
18+
from constructs import Construct
19+
from cdktf import Token, TerraformStack
20+
#
21+
# Provider bindings are generated by running `cdktf get`.
22+
# See https://cdk.tf/provider-generation for more details.
23+
#
24+
from imports.tfe.data_tfe_no_code_module import DataTfeNoCodeModule
25+
from imports.tfe.no_code_module import NoCodeModule
26+
class MyConvertedCode(TerraformStack):
27+
def __init__(self, scope, name):
28+
super().__init__(scope, name)
29+
foobar = NoCodeModule(self, "foobar",
30+
organization=Token.as_string(tfe_organization_foobar.id),
31+
registry_module=Token.as_string(tfe_registry_module_foobar.id)
32+
)
33+
data_tfe_no_code_module_foobar = DataTfeNoCodeModule(self, "foobar_1",
34+
id=foobar.id
35+
)
36+
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.
37+
data_tfe_no_code_module_foobar.override_logical_id("foobar")
38+
```
39+
40+
## Argument Reference
41+
42+
The following arguments are supported:
43+
44+
* `id` - (Required) ID of the no-code module.
45+
46+
## Attributes Reference
47+
48+
* `id` - ID of the no-code module.
49+
* `organization` - Organization name that the no-code module belongs to.
50+
* `namespace` - Namespace name that the no-code module belongs to.
51+
* `registry_module_id` - ID of the registry module for the no-code module.
52+
* `version_pin` - Version number the no-code module is pinned to.
53+
* `enabled` - Indicates if this no-code module is currently enabled
54+
55+
<!-- cache-key: cdktf-0.20.1 input-575fd9c85b909c532a6abcfecdf6262d4ba6675f544b4a4a3a15b6c519eab693 -->

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,7 @@ In addition to all arguments above, the following attributes are exported:
4646
* `cost_estimation_enabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration.
4747
* `owners_team_saml_role_id` - The name of the "owners" team.
4848
* `send_passing_statuses_for_untriggered_speculative_plans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration.
49+
* `aggregated_commit_status_enabled` - 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.
4950
* `default_project_id` - ID of the organization's default project. All workspaces created without specifying a project ID are created in this project.
50-
<!-- cache-key: cdktf-0.20.1 input-8846c33fbd01c623b80272d126fa694263f6e0fb3286ff1830ae6d051a5ae2a2 -->
51+
52+
<!-- cache-key: cdktf-0.20.1 input-944effb44f4d14fb4476a9f26014b95ea0376bb130076243476598735562f471 -->

website/docs/cdktf/python/d/policy_set.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ The following arguments are supported:
4848
* `description` - Description of the policy set.
4949
* `global` - Whether or not the policy set applies to all workspaces in the organization.
5050
* `kind` - The policy-as-code framework for the policy. Valid values are "sentinel" and "opa".
51+
* `agent_enabled` - Whether or not the policy set is run as a policy evaluation within the agent. True by default for all "opa" policy sets.
52+
* `policy_tool_version` - The policy tool version to run the evaluation against.
5153
* `overridable` - Whether users can override this policy when it fails during a run. Only valid for OPA policies.
5254
* `workspace_ids` - IDs of the workspaces that use the policy set.
5355
* `excluded_workspace_ids` - IDs of the workspaces that do not use the policy set.
@@ -67,4 +69,4 @@ The `vcs_repo` block contains:
6769
* `oauth_token_id` - OAuth token ID of the configured VCS connection.
6870

6971

70-
<!-- cache-key: cdktf-0.20.1 input-bff8c51389c3dbd386e33f4eb88fd654798f5c7d466c1606e6c90d22ca8ae19a -->
72+
<!-- cache-key: cdktf-0.20.1 input-d02c3079dfc63899f78fd83cad73af0b541d3dfa9605f525b0e217acf3e5f6c6 -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The above snippet using `required_providers` is for Terraform 0.13+; if you are
8989

9090
```hcl
9191
provider "tfe" {
92-
version = "~> 0.51.1"
92+
version = "~> 0.52.0"
9393
...
9494
}
9595
```
@@ -138,4 +138,4 @@ The following arguments are supported:
138138
arguments. Ensure that the organization already exists prior to using this argument.
139139
This can also be specified using the `TFE_ORGANIZATION` environment variable.
140140

141-
<!-- cache-key: cdktf-0.20.1 input-cc2c69da645bbea9a47c7e55a044b25006ed75ff4fd63fcbb0ce0bd98ee9a7b7 -->
141+
<!-- cache-key: cdktf-0.20.1 input-c9919d4cb1aaeb1d26cb11fc216246a27b831da5d78af26d1e01b428ba6bf7df -->
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_opa_version"
4+
description: |-
5+
Manages OPA versions
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_opa_version
11+
12+
Manage OPA versions available on Terraform Enterprise.
13+
14+
## Example Usage
15+
16+
Basic Usage:
17+
18+
```python
19+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
20+
from constructs import Construct
21+
from cdktf import TerraformStack
22+
#
23+
# Provider bindings are generated by running `cdktf get`.
24+
# See https://cdk.tf/provider-generation for more details.
25+
#
26+
from imports.tfe.opa_version import OpaVersion
27+
class MyConvertedCode(TerraformStack):
28+
def __init__(self, scope, name):
29+
super().__init__(scope, name)
30+
OpaVersion(self, "test",
31+
sha="e75ac73deb69a6b3aa667cb0b8b731aee79e2904",
32+
url="https://tfe-host.com/path/to/opa",
33+
version="0.58.0-custom"
34+
)
35+
```
36+
37+
## Argument Reference
38+
39+
The following arguments are supported:
40+
41+
* `version` - (Required) A semantic version string in N.N.N or N.N.N-bundleName format.
42+
* `url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded.
43+
* `sha` - (Required) The SHA-256 checksum of the compressed OPA binary.
44+
* `official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false".
45+
* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true".
46+
* `beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false".
47+
* `deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false".
48+
* `deprecated_reason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `deprecated` is true.
49+
50+
## Attributes Reference
51+
52+
* `id` The ID of the OPA version
53+
54+
## Import
55+
56+
OPA versions can be imported; use `<OPA VERSION ID>` or `<OPA VERSION NUMBER>` as the import ID. For example:
57+
58+
```shell
59+
terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr
60+
```
61+
62+
```shell
63+
terraform import tfe_opa_version.test 0.58.0
64+
```
65+
66+
-> **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>`
67+
68+
<!-- cache-key: cdktf-0.20.1 input-1151e0ea0d86797d0c36341e282f903e6350d08f2e7a0bcb8dda931532eabc46 -->

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ The following arguments are supported:
4848
* `owners_team_saml_role_id` - (Optional) The name of the "owners" team.
4949
* `cost_estimation_enabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration.
5050
* `send_passing_statuses_for_untriggered_speculative_plans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration.
51+
* `aggregated_commit_status_enabled` - (Optional) 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. If enabled, `send_passing_statuses_for_untriggered_speculative_plans` needs to be false.
5152
* `assessments_enforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences.
5253
* `allow_force_delete_workspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false.
5354

@@ -64,4 +65,4 @@ example:
6465
terraform import tfe_organization.test my-org-name
6566
```
6667

67-
<!-- cache-key: cdktf-0.20.1 input-e999dce0c812e7592cf4dee664b3d7cf3ca7d5544304b1163f915d3bcd134ee2 -->
68+
<!-- cache-key: cdktf-0.20.1 input-8232e931ceb3d6923cd408b51f119f4ae4c80b0a47e8df4bbdd7277ee90208d9 -->

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,13 @@ class MyConvertedCode(TerraformStack):
3434
def __init__(self, scope, name):
3535
super().__init__(scope, name)
3636
PolicySet(self, "test",
37+
agent_enabled=Token.as_boolean("true"),
3738
description="A brand new policy set",
3839
kind="sentinel",
3940
name="my-policy-set",
4041
organization="my-org-name",
4142
policies_path="policies/my-policy-set",
43+
policy_tool_version="0.24.1",
4244
vcs_repo=PolicySetVcsRepo(
4345
branch="main",
4446
identifier="my-org-name/my-policy-set-repository",
@@ -64,11 +66,13 @@ class MyConvertedCode(TerraformStack):
6466
def __init__(self, scope, name):
6567
super().__init__(scope, name)
6668
PolicySet(self, "test",
69+
agent_enabled=Token.as_boolean("true"),
6770
description="A brand new policy set",
6871
kind="sentinel",
6972
name="my-policy-set",
7073
organization="my-org-name",
7174
policy_ids=[Token.as_string(tfe_sentinel_policy_test.id)],
75+
policy_tool_version="0.24.1",
7276
workspace_ids=[Token.as_string(tfe_workspace_test.id)]
7377
)
7478
```
@@ -114,6 +118,9 @@ The following arguments are supported:
114118
* `kind` - (Optional) The policy-as-code framework associated with the policy.
115119
Defaults to `sentinel` if not provided. Valid values are `sentinel` and `opa`.
116120
A policy set can only have policies that have the same underlying kind.
121+
* `agent_enabled` - (Optional) Whether or not the policy set is run as a policy evaluation within the agent.
122+
True by default for all "opa" policy sets.
123+
* `policy_tool_version` - (Optional) The policy tool version to run the evaluation against.
117124
* `overridable` - (Optional) Whether or not users can override this policy when
118125
it fails during a run. Defaults to `false`. Only valid for OPA policies.
119126
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
@@ -159,4 +166,4 @@ Policy sets can be imported; use `<POLICY SET ID>` as the import ID. For example
159166
terraform import tfe_policy_set.test polset-wAs3zYmWAhYK7peR
160167
```
161168

162-
<!-- cache-key: cdktf-0.20.1 input-87dbe1491f5d0ac7c103cc9c7efc59a2174d7dcb1ad313a0a80615bf40216578 -->
169+
<!-- cache-key: cdktf-0.20.1 input-f5ed6bbfb0faff4fcc68c3079d0530b38a7e6e2ba8e335c2c36cb9bdf7764c47 -->
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_sentinel_version"
4+
description: |-
5+
Manages Sentinel versions
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_sentinel_version
11+
12+
Manage Sentinel versions available on Terraform Cloud/Enterprise.
13+
14+
## Example Usage
15+
16+
Basic Usage:
17+
18+
```python
19+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
20+
from constructs import Construct
21+
from cdktf import TerraformStack
22+
#
23+
# Provider bindings are generated by running `cdktf get`.
24+
# See https://cdk.tf/provider-generation for more details.
25+
#
26+
from imports.tfe.sentinel_version import SentinelVersion
27+
class MyConvertedCode(TerraformStack):
28+
def __init__(self, scope, name):
29+
super().__init__(scope, name)
30+
SentinelVersion(self, "test",
31+
sha="e75ac73deb69a6b3aa667cb0b8b731aee79e2904",
32+
url="https://tfe-host.com/path/to/sentinel.zip",
33+
version="0.24.0-custom"
34+
)
35+
```
36+
37+
## Argument Reference
38+
39+
The following arguments are supported:
40+
41+
* `version` - (Required) A semantic version string in N.N.N or N.N.N-bundleName format.
42+
* `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded.
43+
* `sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary.
44+
* `official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false".
45+
* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true".
46+
* `beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false".
47+
* `deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false".
48+
* `deprecated_reason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `deprecated` is true.
49+
50+
## Attributes Reference
51+
52+
* `id` The ID of the Sentinel version
53+
54+
## Import
55+
56+
Sentinel versions can be imported; use `<SENTINEL VERSION ID>` or `<SENTINEL VERSION NUMBER>` as the import ID. For example:
57+
58+
```shell
59+
terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr
60+
```
61+
62+
```shell
63+
terraform import tfe_sentinel_version.test 0.24.0
64+
```
65+
66+
-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-<RANDOM STRING>`
67+
68+
<!-- cache-key: cdktf-0.20.1 input-3fc268f9062224e40c3466ced7572d8d7a91c4e63cf4fac0f66d8b8cc8edc3e6 -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,4 @@ example:
146146
terraform import tfe_team_project_access.admin tprj-2pmtXpZa4YzVMTPi
147147
```
148148

149-
<!-- cache-key: cdktf-0.20.1 input-854ab92b8935bb95bbbbbfaddb8b56a313c125e5e13f6684debaa55ee93499f5 -->
149+
<!-- cache-key: cdktf-0.20.1 input-70d51a3488cdf5b0f4c0f82652aa131c7657aa59a3694f18dcc5814c39bab829 -->
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_no_code_module"
4+
description: |-
5+
Get information on a no-code module.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_provider
11+
12+
Use this data source to read the details of an existing No-Code-Allowed module.
13+
14+
## Example Usage
15+
16+
```typescript
17+
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
18+
import { Construct } from "constructs";
19+
import { Token, TerraformStack } from "cdktf";
20+
/*
21+
* Provider bindings are generated by running `cdktf get`.
22+
* See https://cdk.tf/provider-generation for more details.
23+
*/
24+
import { DataTfeNoCodeModule } from "./.gen/providers/tfe/data-tfe-no-code-module";
25+
import { NoCodeModule } from "./.gen/providers/tfe/no-code-module";
26+
class MyConvertedCode extends TerraformStack {
27+
constructor(scope: Construct, name: string) {
28+
super(scope, name);
29+
const foobar = new NoCodeModule(this, "foobar", {
30+
organization: Token.asString(tfeOrganizationFoobar.id),
31+
registryModule: Token.asString(tfeRegistryModuleFoobar.id),
32+
});
33+
const dataTfeNoCodeModuleFoobar = new DataTfeNoCodeModule(
34+
this,
35+
"foobar_1",
36+
{
37+
id: foobar.id,
38+
}
39+
);
40+
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
41+
dataTfeNoCodeModuleFoobar.overrideLogicalId("foobar");
42+
}
43+
}
44+
45+
```
46+
47+
## Argument Reference
48+
49+
The following arguments are supported:
50+
51+
* `id` - (Required) ID of the no-code module.
52+
53+
## Attributes Reference
54+
55+
* `id` - ID of the no-code module.
56+
* `organization` - Organization name that the no-code module belongs to.
57+
* `namespace` - Namespace name that the no-code module belongs to.
58+
* `registryModuleId` - ID of the registry module for the no-code module.
59+
* `versionPin` - Version number the no-code module is pinned to.
60+
* `enabled` - Indicates if this no-code module is currently enabled
61+
62+
<!-- cache-key: cdktf-0.20.1 input-575fd9c85b909c532a6abcfecdf6262d4ba6675f544b4a4a3a15b6c519eab693 -->

0 commit comments

Comments
 (0)