Skip to content

Commit 8785413

Browse files
brandoncbrandonc
authored
Merge pull request #1167 from hashicorp/d-cdktf-docs-7161173285-48
cdktf: update documentation
2 parents da52dd3 + 7d45da9 commit 8785413

10 files changed

+466
-8
lines changed

‎website/docs/cdktf/python/d/registry_gpg_key.html.markdown‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_registry_gpg_key"
4+
description: |-
5+
Get information on a private registry GPG key.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_gpg_key
11+
12+
Use this data source to get information about a private registry GPG key.
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 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. import DataTfeRegistryGpgKey
25+
class MyConvertedCode(TerraformStack):
26+
def __init__(self, scope, name):
27+
super().__init__(scope, name)
28+
DataTfeRegistryGpgKey(self, "example",
29+
id="13DFECCA3B58CE4A",
30+
organization="my-org-name"
31+
)
32+
```
33+
34+
## Argument Reference
35+
36+
The following arguments are supported:
37+
38+
* `id` - (Required) ID of the GPG key.
39+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
40+
41+
## Attributes Reference
42+
43+
* `ascii_armor` - ASCII-armored representation of the GPG key.
44+
* `created_at` - The time when the GPG key was created.
45+
* `updated_at` - The time when the GPG key was last updated.
46+
47+
<!-- cache-key: cdktf-0.19.0 input-7cf721398cc48785bd0ab8f949360d917b2cadf37b1f704b8747ee2c07ced5d4 -->

‎website/docs/cdktf/python/d/registry_gpg_keys.html.markdown‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_registry_gpg_keys"
4+
description: |-
5+
Get information on private registry GPG keys of an organization.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_gpg_key
11+
12+
Use this data source to get information about all private registry GPG keys of an organization.
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 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. import DataTfeRegistryGpgKeys
25+
class MyConvertedCode(TerraformStack):
26+
def __init__(self, scope, name):
27+
super().__init__(scope, name)
28+
DataTfeRegistryGpgKeys(self, "all",
29+
organization="my-org-name"
30+
)
31+
```
32+
33+
## Argument Reference
34+
35+
The following arguments are supported:
36+
37+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
38+
39+
## Attributes Reference
40+
41+
* `keys` - List of GPG keys in the organization. Each element contains the following attributes:
42+
* `id` - ID of the GPG key.
43+
* `organization` - Name of the organization.
44+
* `ascii_armor` - ASCII-armored representation of the GPG key.
45+
* `created_at` - The time when the GPG key was created.
46+
* `updated_at` - The time when the GPG key was last updated.
47+
48+
<!-- cache-key: cdktf-0.19.0 input-985032e5d21704bbf9d65466c89a423c9765fcddc79c819677b5b011797a49e7 -->

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

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_registry_gpg_key"
4+
description: |-
5+
Manages private registry GPG keys.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_registry_gpg_key
11+
12+
Manages a public key of the GPG key pair used to sign releases of private providers in the private registry.
13+
14+
The provided GPG key must be ASCII-armored, i.e. starting with:
15+
"`-----BEGIN PGP PUBLIC KEY BLOCK-----\n\n...`".
16+
17+
## Example Usage
18+
19+
```python
20+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
21+
from constructs import Construct
22+
from cdktf import Fn, TerraformStack
23+
#
24+
# Provider bindings are generated by running `cdktf get`.
25+
# See https://cdk.tf/provider-generation for more details.
26+
#
27+
from imports.tfe. import RegistryGpgKey
28+
class MyConvertedCode(TerraformStack):
29+
def __init__(self, scope, name):
30+
super().__init__(scope, name)
31+
RegistryGpgKey(self, "example",
32+
ascii_armor=Fn.file("my-public-key.asc"),
33+
organization="my-org-name"
34+
)
35+
```
36+
37+
## Argument Reference
38+
39+
The following arguments are supported:
40+
41+
* `ascii_armor` - (Required) ASCII-armored representation of the GPG key.
42+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
43+
44+
## Attributes Reference
45+
46+
* `id` - ID of the GPG key.
47+
* `created_at` - The time when the GPG key was created.
48+
* `updated_at` - The time when the GPG key was last updated.
49+
50+
## Import
51+
52+
Keys can be imported; use `<ORGANIZATION NAME>/<KEY ID>` as the import ID. For
53+
example:
54+
55+
```shell
56+
terraform import tfe_registry_gpg_key.example my-org-name/34365D9472D7468F
57+
```
58+
59+
<!-- cache-key: cdktf-0.19.0 input-730b5a234f42b288032d37e5a9ddea76c748a891a6ac2df444a35f192edf1bc4 -->

‎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/d/registry_gpg_key.html.markdown‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_registry_gpg_key"
4+
description: |-
5+
Get information on a private registry GPG key.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_gpg_key
11+
12+
Use this data source to get information about a private registry GPG key.
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 { 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 { DataTfeRegistryGpgKey } from "./.gen/providers/tfe/";
25+
class MyConvertedCode extends TerraformStack {
26+
constructor(scope: Construct, name: string) {
27+
super(scope, name);
28+
new DataTfeRegistryGpgKey(this, "example", {
29+
id: "13DFECCA3B58CE4A",
30+
organization: "my-org-name",
31+
});
32+
}
33+
}
34+
35+
```
36+
37+
## Argument Reference
38+
39+
The following arguments are supported:
40+
41+
* `id` - (Required) ID of the GPG key.
42+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
43+
44+
## Attributes Reference
45+
46+
* `asciiArmor` - ASCII-armored representation of the GPG key.
47+
* `createdAt` - The time when the GPG key was created.
48+
* `updatedAt` - The time when the GPG key was last updated.
49+
50+
<!-- cache-key: cdktf-0.19.0 input-7cf721398cc48785bd0ab8f949360d917b2cadf37b1f704b8747ee2c07ced5d4 -->

‎website/docs/cdktf/typescript/d/registry_gpg_keys.html.markdown‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_registry_gpg_keys"
4+
description: |-
5+
Get information on private registry GPG keys of an organization.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_gpg_key
11+
12+
Use this data source to get information about all private registry GPG keys of an organization.
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 { 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 { DataTfeRegistryGpgKeys } from "./.gen/providers/tfe/";
25+
class MyConvertedCode extends TerraformStack {
26+
constructor(scope: Construct, name: string) {
27+
super(scope, name);
28+
new DataTfeRegistryGpgKeys(this, "all", {
29+
organization: "my-org-name",
30+
});
31+
}
32+
}
33+
34+
```
35+
36+
## Argument Reference
37+
38+
The following arguments are supported:
39+
40+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
41+
42+
## Attributes Reference
43+
44+
* `keys` - List of GPG keys in the organization. Each element contains the following attributes:
45+
* `id` - ID of the GPG key.
46+
* `organization` - Name of the organization.
47+
* `ascii_armor` - ASCII-armored representation of the GPG key.
48+
* `created_at` - The time when the GPG key was created.
49+
* `updated_at` - The time when the GPG key was last updated.
50+
51+
<!-- cache-key: cdktf-0.19.0 input-985032e5d21704bbf9d65466c89a423c9765fcddc79c819677b5b011797a49e7 -->

0 commit comments

Comments
 (0)