Skip to content

Commit d902196

Browse files
team-tf-cdkteam-tf-cdk
committed
cdktf: update index.html.markdown,r/workspace_variable_set.html.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_organization_default_execution_mode.html.markdown
1 parent 596951c commit d902196

File tree

4 files changed

+149
-8
lines changed

4 files changed

+149
-8
lines changed

‎website/docs/cdktf/python/r/tfe_organization_default_execution_mode.html.markdown‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_organization_default_execution_mode"
4+
description: |-
5+
Sets the default execution mode of an organization
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_organization_default_execution_mode
11+
12+
Sets the default execution mode of an organization. This default execution mode will be used as the default execution mode for all workspaces in the organization.
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. import OrganizationDefaultExecutionMode
27+
from imports.tfe.agent_pool import AgentPool
28+
from imports.tfe.organization import Organization
29+
class MyConvertedCode(TerraformStack):
30+
def __init__(self, scope, name):
31+
super().__init__(scope, name)
32+
test = Organization(self, "test",
33+
email="[email protected]",
34+
name="my-org-name"
35+
)
36+
my_agents = AgentPool(self, "my_agents",
37+
name="agent_smiths",
38+
organization=test.name
39+
)
40+
OrganizationDefaultExecutionMode(self, "org_default",
41+
default_agent_pool_id=my_agents.id,
42+
default_execution_mode="agent",
43+
organization=test.name
44+
)
45+
```
46+
47+
## Argument Reference
48+
49+
The following arguments are supported:
50+
51+
* `default_execution_mode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode)
52+
to use as the default for all workspaces in the organization. Valid values are `remote`, `local` or`agent`.
53+
* `agent_pool_id` - (Optional) The ID of an agent pool to assign to the workspace. Requires `default_execution_mode`
54+
to be set to `agent`. This value _must not_ be provided if `default_execution_mode` is set to any other value or if `operations` is
55+
provided.
56+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
57+
58+
59+
## Import
60+
61+
Organization default execution mode can be imported; use `<ORGANIZATION NAME>` as the import ID. For example:
62+
63+
```shell
64+
terraform import tfe_organization_default_execution_mode.test my-org-name
65+
```
66+
<!-- cache-key: cdktf-0.19.0 input-ed8965a40d18f988022c7c7aac067a018e5fa24eec1e6d94abd36c11a0971d1a -->

‎website/docs/cdktf/python/r/workspace.html.markdown‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ The following arguments are supported:
8787
* `auto_apply_run_trigger` - (Optional) Whether to automatically apply changes for runs that were created by run triggers from another workspace. Defaults to `false`.
8888
* `description` - (Optional) A description for the workspace.
8989
* `execution_mode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode)
90-
to use. Using Terraform Cloud, valid values are `remote`, `local` or`agent`.
91-
Defaults to `remote`. Using Terraform Enterprise, only `remote`and `local`
90+
to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`.
91+
Defaults your organization's default execution mode, or `remote` if no organization default is set. Using Terraform Enterprise, only `remote` and `local`
9292
execution modes are valid. When set to `local`, the workspace will be used
9393
for state storage only. This value _must not_ be provided if `operations`
9494
is provided.
@@ -169,7 +169,10 @@ In addition to all arguments above, the following attributes are exported:
169169

170170
* `id` - The workspace ID.
171171
* `resource_count` - The number of resources managed by the workspace.
172-
* `html_url` - The URL to the browsable HTML overview of the workspace
172+
* `html_url` - The URL to the browsable HTML overview of the workspace.
173+
* `setting_overwrites` - Can be used to check whether a setting is currently inheriting its value from another resource.
174+
- `execution_mode` - Set to `true` if the execution mode of the workspace is being determined by the setting on the workspace itself. It will be `false` if the execution mode is inherited from another resource (e.g. the organization's default execution mode)
175+
- `agent_pool` - Set to `true` if the agent pool of the workspace is being determined by the setting on the workspace itself. It will be `false` if the agent pool is inherited from another resource (e.g. the organization's default agent pool)
173176

174177
## Import
175178

@@ -184,4 +187,4 @@ terraform import tfe_workspace.test ws-CH5in3chf8RJjrVd
184187
terraform import tfe_workspace.test my-org-name/my-wkspace-name
185188
```
186189

187-
<!-- cache-key: cdktf-0.19.0 input-ce8c5d41ebbc57c1df647c807e38b748d12221b61915ccc24e4f1530f58312b5 -->
190+
<!-- cache-key: cdktf-0.19.0 input-25e2316b67d698d4aec45557feedf54b6a8dfa43a6381d9c433cf7afabed73c9 -->

‎website/docs/cdktf/typescript/r/tfe_organization_default_execution_mode.html.markdown‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_organization_default_execution_mode"
4+
description: |-
5+
Sets the default execution mode of an organization
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_organization_default_execution_mode
11+
12+
Sets the default execution mode of an organization. This default execution mode will be used as the default execution mode for all workspaces in the organization.
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
```typescript
19+
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
20+
import { Construct } from "constructs";
21+
import { TerraformStack } from "cdktf";
22+
/*
23+
* Provider bindings are generated by running `cdktf get`.
24+
* See https://cdk.tf/provider-generation for more details.
25+
*/
26+
import { OrganizationDefaultExecutionMode } from "./.gen/providers/tfe/";
27+
import { AgentPool } from "./.gen/providers/tfe/agent-pool";
28+
import { Organization } from "./.gen/providers/tfe/organization";
29+
class MyConvertedCode extends TerraformStack {
30+
constructor(scope: Construct, name: string) {
31+
super(scope, name);
32+
const test = new Organization(this, "test", {
33+
email: "[email protected]",
34+
name: "my-org-name",
35+
});
36+
const myAgents = new AgentPool(this, "my_agents", {
37+
name: "agent_smiths",
38+
organization: test.name,
39+
});
40+
new OrganizationDefaultExecutionMode(this, "org_default", {
41+
default_agent_pool_id: myAgents.id,
42+
default_execution_mode: "agent",
43+
organization: test.name,
44+
});
45+
}
46+
}
47+
48+
```
49+
50+
## Argument Reference
51+
52+
The following arguments are supported:
53+
54+
* `defaultExecutionMode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode)
55+
to use as the default for all workspaces in the organization. Valid values are `remote`, `local` or`agent`.
56+
* `agentPoolId` - (Optional) The ID of an agent pool to assign to the workspace. Requires `default_execution_mode`
57+
to be set to `agent`. This value _must not_ be provided if `default_execution_mode` is set to any other value or if `operations` is
58+
provided.
59+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
60+
61+
62+
## Import
63+
64+
Organization default execution mode can be imported; use `<ORGANIZATION NAME>` as the import ID. For example:
65+
66+
```shell
67+
terraform import tfe_organization_default_execution_mode.test my-org-name
68+
```
69+
<!-- cache-key: cdktf-0.19.0 input-ed8965a40d18f988022c7c7aac067a018e5fa24eec1e6d94abd36c11a0971d1a -->

‎website/docs/cdktf/typescript/r/workspace.html.markdown‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ The following arguments are supported:
9393
* `autoApplyRunTrigger` - (Optional) Whether to automatically apply changes for runs that were created by run triggers from another workspace. Defaults to `false`.
9494
* `description` - (Optional) A description for the workspace.
9595
* `executionMode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode)
96-
to use. Using Terraform Cloud, valid values are `remote`, `local` or`agent`.
97-
Defaults to `remote`. Using Terraform Enterprise, only `remote`and `local`
96+
to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`.
97+
Defaults your organization's default execution mode, or `remote` if no organization default is set. Using Terraform Enterprise, only `remote` and `local`
9898
execution modes are valid. When set to `local`, the workspace will be used
9999
for state storage only. This value _must not_ be provided if `operations`
100100
is provided.
@@ -175,7 +175,10 @@ In addition to all arguments above, the following attributes are exported:
175175

176176
* `id` - The workspace ID.
177177
* `resourceCount` - The number of resources managed by the workspace.
178-
* `htmlUrl` - The URL to the browsable HTML overview of the workspace
178+
* `htmlUrl` - The URL to the browsable HTML overview of the workspace.
179+
* `settingOverwrites` - Can be used to check whether a setting is currently inheriting its value from another resource.
180+
- `execution_mode` - Set to `true` if the execution mode of the workspace is being determined by the setting on the workspace itself. It will be `false` if the execution mode is inherited from another resource (e.g. the organization's default execution mode)
181+
- `agent_pool` - Set to `true` if the agent pool of the workspace is being determined by the setting on the workspace itself. It will be `false` if the agent pool is inherited from another resource (e.g. the organization's default agent pool)
179182

180183
## Import
181184

@@ -190,4 +193,4 @@ terraform import tfe_workspace.test ws-CH5in3chf8RJjrVd
190193
terraform import tfe_workspace.test my-org-name/my-wkspace-name
191194
```
192195

193-
<!-- cache-key: cdktf-0.19.0 input-ce8c5d41ebbc57c1df647c807e38b748d12221b61915ccc24e4f1530f58312b5 -->
196+
<!-- cache-key: cdktf-0.19.0 input-25e2316b67d698d4aec45557feedf54b6a8dfa43a6381d9c433cf7afabed73c9 -->

0 commit comments

Comments
 (0)