Skip to content

Commit 3991a49

Browse files
committed
cdktf: update documentation
1 parent e64b201 commit 3991a49

File tree

265 files changed

+6476
-6090
lines changed

Some content is hidden

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

265 files changed

+6476
-6090
lines changed

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ The following attributes are exported:
4141

4242
* `Api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs.
4343
* `Notifications` - The list of IP ranges in CIDR notation used for notifications.
44-
* `Sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies.
44+
* `Sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. Applicable for [Policy Checks](https://developer.hashicorp.com/terraform/cloud-docs/policy-enforcement/manage-policy-sets#policy-checks) mode only (also known as Legacy mode).
4545
* `Vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers.
4646

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

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,6 @@ In addition to all arguments above, the following attributes are exported:
4747
* `Id` - The project ID.
4848
* `WorkspaceIds` - IDs of the workspaces that are associated with the project.
4949
* `WorkspaceNames` - Names of the workspaces that are associated with the project.
50+
* `EffectiveTags` - A map of key-value tags associated with the project.
5051

51-
<!-- cache-key: cdktf-0.17.0-pre.15 input-c0fb226c1ac838d85660d99cb036d77ac141264beb3f94ffd4b3e2369f67b971 -->
52+
<!-- cache-key: cdktf-0.17.0-pre.15 input-d6ced138e71a16de8ba95b284a41c0a5b1ee88185ba1da147742ea5af9e97163 -->
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_registry_module"
4+
description: |-
5+
Get information on a registry module
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_registry_module
11+
12+
Use this data source to get information about a registry module.
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
Since modules have a [required naming convention](https://developer.hashicorp.com/terraform/registry/modules/publish#requirements), you can get these values from your module repository (`Terraform-<moduleProvider>-<name>`).
19+
20+
```hcl
21+
data "tfe_registry_module" "example" {
22+
organization = var.organization_name
23+
name = "no-code-ssm"
24+
module_provider = "aws"
25+
}
26+
```
27+
28+
## Argument Reference
29+
30+
The following arguments are required:
31+
32+
* `Organization` - (Required) The name of the organization associated with the registry module.
33+
* `Name` - (Required) The name of the module. Can be found from repository name convention `Terraform-<provider>-<name>`
34+
* `ModuleProvider` - (Required) The provider associated with the module. Can be found from repository name convention `Terraform-<provider>-<name>`
35+
36+
The following arguments are supported:
37+
38+
* `Namespace` - (Optional) The namespace of a registry module. Typically this is the same as the organization name. Defaults to `Organization` value.
39+
* `RegistryName` - (Optional) The registry name of a registry module. Valid options: "public", "private". Defaults to "private".
40+
41+
## Attributes Reference
42+
43+
* `Id` - The ID of the registry module.
44+
* `NoCodeModuleId` - The ID of the no-code module, if enabled.
45+
* `NoCodeModuleSource` - The source value of the no-code module (`<ORGANIZATION>/<REGISTRY_NAME>/<NAMESPACE>/<REGISTRY MODULE NAME>/<REGISTRY MODULE PROVIDER>`).
46+
* `NoCode` - Boolean value if no-code module is enabled.
47+
* `PublishingMechanism` - The publishing mechanism used when releasing new versions of the module.
48+
* `VcsRepo` - Settings for the registry module's VCS repository.
49+
* `Permissions` - The permissions on a module.
50+
* `Status` - Current status of registry module.
51+
* `TestConfig` - Test configuration indicating module testing setup.
52+
* `VersionStatuses` - Version information for a given module.
53+
* `CreatedAt` - Date module was created.
54+
* `UpdatedAt` - Date module was last updated.
55+
56+
The `VcsRepo` block supports:
57+
58+
* `DisplayIdentifier` - The display identifier for your VCS repository.
59+
For most VCS providers outside of BitBucket Cloud and Azure DevOps, this will match the `Identifier`
60+
string.
61+
* `Identifier` - A reference to your VCS repository in the format
62+
`<organization>/<repository>` where `<organization>` and `<repository>` refer to the organization (or project key, for Bitbucket Data Center)
63+
and repository in your VCS provider. The format for Azure DevOps is `<ado organization>/<ado project>/_git/<ado repository>`.
64+
* `OauthTokenId` - Token ID of the VCS Connection (OAuth Connection Token) to use. This conflicts with `GithubAppInstallationId` and can only be used if `GithubAppInstallationId` is not used.
65+
* `GithubAppInstallationId` - The installation id of the Github App. This conflicts with `OauthTokenId` and can only be used if `OauthTokenId` is not used.
66+
* `Branch` - The git branch used for publishing when using branch-based publishing for the registry module. When a `Branch` is set, `Tags` will be returned as `False`.
67+
* `Tags` - Specifies whether tag based publishing is enabled for the registry module. When `Tags` is set to `True`, the `Branch` must be set to an empty value.
68+
* `SourceDirectory` - (Optional) The path to the module configuration files within the VCS repository. This feature is currently in beta and is not available to all users.
69+
* `TagPrefix` - (Optional) The prefix to filter repository Git tags when using the tag-based publishing type in a repository that contains code for multiple modules. Without a prefix, HCP Terraform and Terraform Enterprise publish new versions for all modules with valid Git tags that use semantic versioning. This feature is currently in beta and is not available to all users.
70+
71+
The `Permissions` block supports:
72+
73+
- `CanDelete` - Can delete.
74+
- `CanResync` - Can resync.
75+
- `CanRetry` - Can retry.
76+
77+
The `TestConfig` block supports:
78+
79+
- `TestsEnabled` - Indicates whether tests are enabled for a module
80+
81+
The `VersionStatuses` block supports:
82+
83+
- `Version` - Version of the module.
84+
- `Status` - Status of the module at specific version.
85+
- `Error` - Error message reported by module at specific version.
86+
87+
<!-- cache-key: cdktf-0.17.0-pre.15 input-4e070a783ac5323a3d4e4695e30e82f9ea41c06d28727cb2d440dd13a23e049f -->

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on a SSH key.
66
---
77

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

1012
Use this data source to get information about a SSH key.
@@ -34,12 +36,13 @@ class MyConvertedCode : TerraformStack
3436
The following arguments are supported:
3537

3638
* `Name` - (Required) Name of the SSH key.
37-
* `Organization` - (Required) Name of the organization.
39+
* `Organization` - (Optional) Name of the organization. If omitted, organization
40+
must be defined in the provider config.
3841

3942
## Attributes Reference
4043

4144
In addition to all arguments above, the following attributes are exported:
4245

4346
* `Id` - The ID of the SSH key.
4447

45-
<!-- cache-key: cdktf-0.17.0-pre.15 input-806b3725b385ea145f9913c0e0d9cd7b045ae9faf7bb22bbddfa40eda1fb10e3 -->
48+
<!-- cache-key: cdktf-0.17.0-pre.15 input-eb29ed64f702678fe5f4e16b19cee416f189775eb585e2b64df226614d29f489 -->

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ In addition to all arguments above, the following attributes are exported:
6969
* `SpeculativeEnabled` - Indicates whether this workspace allows speculative plans.
7070
* `SshKeyId` - The ID of an SSH key assigned to the workspace.
7171
* `StructuredRunOutputEnabled` - Indicates whether runs in this workspace use the enhanced apply UI.
72+
* `EffectiveTags` - A map of key-value tags associated with the workspace, including any inherited tags from the parent project.
7273
* `TagNames` - The names of tags added to this workspace.
7374
* `TerraformVersion` - The version (or version constraint) of Terraform used for this workspace.
7475
* `TriggerPrefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository.
@@ -91,4 +92,4 @@ The `VcsRepo` block contains:
9192
* `OauthTokenId` - OAuth token ID of the configured VCS connection.
9293
* `TagsRegex` - A regular expression used to trigger a Workspace run for matching Git tags.
9394

94-
<!-- cache-key: cdktf-0.17.0-pre.15 input-d80e2cf72aa52f98270a38620225ac1ef8a4810885e13dedc294ad2c1d21c880 -->
95+
<!-- cache-key: cdktf-0.17.0-pre.15 input-00e997c6f8d35b250c70aa4e4630b8d9ed6e2e553f58e34786b6567776e4a1ef -->

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

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

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

1012
Use this data source to get a map of workspace IDs.
@@ -29,6 +31,33 @@ class MyConvertedCode : TerraformStack
2931
Names = new [] { "app-frontend-prod", "app-frontend-dev1", "app-frontend-staging" },
3032
Organization = "my-org-name"
3133
});
34+
new DataTfeWorkspaceIds.DataTfeWorkspaceIds(this, "dev_env_tags_only", new DataTfeWorkspaceIdsConfig {
35+
Organization = "my-org-name",
36+
TagFilters = new DataTfeWorkspaceIdsTagFilters {
37+
Include = new Dictionary<string, string> {
38+
{ "environment", "dev" }
39+
}
40+
}
41+
});
42+
new DataTfeWorkspaceIds.DataTfeWorkspaceIds(this, "exclude_all_matching_key", new DataTfeWorkspaceIdsConfig {
43+
Organization = "my-org-name",
44+
TagFilters = new DataTfeWorkspaceIdsTagFilters {
45+
Exclude = new Dictionary<string, string> {
46+
{ "bad_key", "*" }
47+
}
48+
}
49+
});
50+
new DataTfeWorkspaceIds.DataTfeWorkspaceIds(this, "include_and_exclude", new DataTfeWorkspaceIdsConfig {
51+
Organization = "my-org-name",
52+
TagFilters = new DataTfeWorkspaceIdsTagFilters {
53+
Exclude = new Dictionary<string, string> {
54+
{ "team", "prodsec" }
55+
},
56+
Include = new Dictionary<string, string> {
57+
{ "region", "us-east-1" }
58+
}
59+
}
60+
});
3261
new DataTfeWorkspaceIds.DataTfeWorkspaceIds(this, "prod-apps", new DataTfeWorkspaceIdsConfig {
3362
Organization = "my-org-name",
3463
TagNames = new [] { "prod", "app", "aws" }
@@ -51,15 +80,21 @@ The following arguments are supported. At least one of `Names` or `TagNames` mus
5180

5281
To select _all_ workspaces for an organization, provide a list with a single
5382
asterisk, like `["*"]`. The asterisk also supports partial matching on prefix and/or suffix, like `[*Prod]`, `[test-*]`, `[*dev*]`.
54-
* `TagNames` - (Optional) A list of tag names to search for.
55-
* `ExcludeTags` - (Optional) A list of tag names to exclude when searching.
83+
* `TagFilters` - (Optional) A set of key-value tag filters to search for workspaces.
84+
* `TagNames` - (Optional) **Deprecated** A list of tag names to search for.
85+
* `ExcludeTags` - (Optional) **Deprecated** A list of tag names to exclude when searching.
5686
* `Organization` - (Required) Name of the organization.
5787

88+
The `TagFilters` block supports:
89+
90+
* `Include`: (Optional) A map of key-value tags the workspaces must contain. Each tag included here will be combined using a logical AND when filtering results.
91+
* `Exclude`: (Optional) A map of key-value tags to exclude workspaces from the returned list. To exclude all workspaces containing a specific key, use `"*"` as the value.
92+
5893
## Attributes Reference
5994

6095
In addition to all arguments above, the following attributes are exported:
6196

6297
* `FullNames` - A map of workspace names and their full names, which look like `<ORGANIZATION>/<WORKSPACE>`.
6398
* `Ids` - A map of workspace names and their opaque, immutable IDs, which look like `ws-<RANDOM STRING>`.
6499

65-
<!-- cache-key: cdktf-0.17.0-pre.15 input-a50ddfd1d990de8d1cbdba1a7182f9b5d086fbc397439bdd1d0bd057263938e3 -->
100+
<!-- cache-key: cdktf-0.17.0-pre.15 input-59fc5c7e05bb6177bb75c0977a805249523a5ecc467f69e0c8d67905a2b343a2 -->
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: Ephemeral: tfe_outputs"
4+
description: |-
5+
Get output values from another organization/workspace without writing
6+
sensitive data to state.
7+
---
8+
9+
10+
<!-- Please do not edit this file, it is generated. -->
11+
# Ephemeral: tfe_outputs
12+
13+
This ephemeral resource is used to retrieve the state outputs for a given workspace.
14+
It enables output values in one Terraform configuration to be used in another.
15+
The retrieved output values are guaranteed not to be written to state.
16+
17+
~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral).
18+
19+
---
20+
21+
~> **NOTE:** Regardless of the sensitivity of the output values as set in HCP
22+
Terraform, the `Values` and `NonsensitiveValues` attributes in this ephemeral
23+
resource are both treated as sensitive.
24+
25+
## Example Usage
26+
27+
Using the `TfeOutputs` ephemeral resource, the outputs `VaultRoleId` and `VaultSecretId` can be used to configure a vault provider instance as seen below:
28+
29+
In the example below, assume we have outputs defined in a `MyOrg/myWorkspace`:
30+
31+
```hcl
32+
ephemeral "tfe_outputs" "foo" {
33+
organization = "my-org"
34+
workspace = "my-workspace"
35+
}
36+
37+
provider "vault" {
38+
auth_login {
39+
path = "auth/approle/login"
40+
41+
parameters = {
42+
role_id = ephemeral_tfe_outputs.foo.values.vault_role_id
43+
secret_id = ephemeral_tfe_outputs.foo.values.vault_secret_id
44+
}
45+
}
46+
}
47+
```
48+
49+
## Argument Reference
50+
51+
The following arguments are supported:
52+
53+
* `Organization` - (Optional) The name of the organization. If omitted, the
54+
organization must be defined in the provider config.
55+
* `Workspace` - (Required) The name of the workspace.
56+
57+
## Attributes Reference
58+
59+
The following attributes are exported:
60+
61+
* `Values` - The current output values for the specified workspace.
62+
* `NonsensitiveValues` - The current non-sensitive output values for the specified workspace, this is a subset of all output values.
63+
64+
<!-- cache-key: cdktf-0.17.0-pre.15 input-25868a462b51b850499a9e695e33687f8cb610c5427b2aba1ca0998eac2049fc -->
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: Ephemeral: tfe_team_token"
4+
description: |-
5+
Generates an ephemeral team token.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Ephemeral: tfe_team_token
11+
12+
Generates an ephemeral team token for use during a Terraform run.
13+
14+
Ephemeral team tokens are only valid within the context of a single run, and
15+
are not stored in Terraform state.
16+
17+
Ephemeral resources are provisioned during the plan phase of a run as well as
18+
the apply phase.
19+
20+
If you need the team token to remain valid for long-lived use, consider using the
21+
`TfeTeamToken` managed resource instead.
22+
23+
~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral).
24+
25+
## Example Usage
26+
27+
### Generate a new team token:
28+
29+
This will invalidate any existing team token.
30+
31+
```hcl
32+
resource "tfe_team" "example" {
33+
organization = "my-org-name"
34+
name = "my-team-name"
35+
}
36+
37+
ephemeral "tfe_team_token" "example" {
38+
team_id = tfe_team.example.id
39+
}
40+
```
41+
42+
## Argument Reference
43+
44+
The following arguments are required:
45+
46+
* `TeamId` - (Required) ID of the team.
47+
48+
The following arguments are optional:
49+
50+
* `ExpiredAt` - (Optional) The token's expiration date. The expiration date must be a date/time string in RFC3339
51+
format (e.g., "2024-12-31T23:59:59Z"). If no expiration date is supplied, the expiration date will default to null and
52+
never expire.
53+
54+
This ephemeral resource exports the following attributes in addition to the arguments above:
55+
56+
* `Token` - The generated token. This value is sensitive and will not be stored
57+
in state.
58+
59+
<!-- cache-key: cdktf-0.17.0-pre.15 input-392968ac0f012ea80837f8853f23ad92cb0723053dd23744b461934c5de20dd9 -->

0 commit comments

Comments
 (0)