Skip to content

Commit 8a140d1

Browse files
uturunku1uturunku1
authored
cdktf: update documentation
1 parent 1dda936 commit 8a140d1

30 files changed

+1413
-22
lines changed

‎website/docs/cdktf/csharp/d/policy_set.html.markdown‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on organization policy sets.
66
---
77

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

1012
This data source is used to retrieve a policy set defined in a specified organization.
@@ -48,6 +50,7 @@ The following arguments are supported:
4850
* `Kind` - The policy-as-code framework for the policy. Valid values are "sentinel" and "opa".
4951
* `Overridable` - Whether users can override this policy when it fails during a run. Only valid for OPA policies.
5052
* `WorkspaceIds` - IDs of the workspaces that use the policy set.
53+
* `ProjectIds` - IDs of the projects that use the policy set.
5154
* `PolicyIds` - IDs of the policies attached to the policy set.
5255
* `PoliciesPath` - The sub-path within the attached VCS repository when using `VcsRepo`.
5356
* `VcsRepo` - Settings for the workspace's VCS repository.
@@ -63,4 +66,4 @@ The `VcsRepo` block contains:
6366
* `OauthTokenId` - OAuth token ID of the configured VCS connection.
6467

6568

66-
<!-- cache-key: cdktf-0.17.0-pre.15 input-369a7ffb16c0ab83ebbbde324972bb3020c1f6cf5bfbf759dc0563f1d5a4b8b1 -->
69+
<!-- cache-key: cdktf-0.17.0-pre.15 input-54cb92dfae22abe76f4a8306daadcae6353d03b00d72dfbb74c8950c625507e0 -->

‎website/docs/cdktf/csharp/d/saml_settings.html.markdown‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_saml_settings"
4+
description: |-
5+
Get information on SAML Settings.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# Data Source: tfe_saml_settings
11+
12+
Use this data source to get information about SAML Settings. It applies only to Terraform Enterprise and requires admin token configuration. See example usage for incorporating an admin token in your provider config.
13+
14+
15+
## Example Usage
16+
17+
Basic usage:
18+
19+
```hcl
20+
provider "tfe" {
21+
hostname = var.hostname
22+
token = var.token
23+
}
24+
25+
provider "tfe" {
26+
alias = "admin"
27+
hostname = var.hostname
28+
token = var.admin_token
29+
}
30+
31+
data "tfe_saml_settings" "foo" {
32+
provider = tfe.admin
33+
}
34+
```
35+
36+
## Argument Reference
37+
38+
No arguments are required for this data source.
39+
40+
## Attributes Reference
41+
42+
The following attributes are exported:
43+
44+
* `Id` - It is always `Saml`.
45+
* `Enabled` - Whether SAML single sign-on is enabled.
46+
* `Debug` - Whether debug mode is enabled, which means that the SAMLResponse XML will be displayed on the login page.
47+
* `TeamManagementEnabled` - Whether Terraform Enterprise is set to manage team membership.
48+
* `AuthnRequestsSigned` - Whether `<samlp:AuthnRequest>` messages are signed.
49+
* `WantAssertionsSigned` - Whether `<saml:Assertion>` elements are signed.
50+
* `IdpCert` - PEM encoded X.509 Certificate as provided by the IdP configuration.
51+
* `OldIdpCert` - Previous version of the PEM encoded X.509 Certificate as provided by the IdP configuration.
52+
* `SloEndpointUrl` - Single Log Out URL.
53+
* `SsoEndpointUrl` - Single Sign On URL.
54+
* `AttrUsername` - Name of the SAML attribute that determines the user's username.
55+
* `AttrGroups` - Name of the SAML attribute that determines team membership.
56+
* `AttrSiteAdmin` - Site admin access role.
57+
* `SiteAdminRole` - Site admin access role.
58+
* `SsoApiTokenSessionTimeout` - Single Sign On session timeout in seconds.
59+
* `AcsConsumerUrl` - ACS Consumer (Recipient) URL.
60+
* `MetadataUrl` - Metadata (Audience) URL.
61+
* `Certificate` - Request and assertion signing certificate.
62+
* `Certificate` - Request and assertion signing certificate.
63+
* `PrivateKey` - The private key used for request and assertion signing.
64+
* `SignatureSigningMethod` - Signature Signing Method.
65+
* `SignatureDigestMethod` - Signature Digest Method.
66+
67+
<!-- cache-key: cdktf-0.17.0-pre.15 input-2995e79c51b29afd8d8b89c5d98dae47701709e1502f993d5be8b2b681de4895 -->

‎website/docs/cdktf/csharp/index.html.markdown‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp.
66
---
77

8+
9+
<!-- Please do not edit this file, it is generated. -->
810
# Terraform Cloud/Enterprise Provider
911

1012
This provider is used to interact with the many resources supported by
@@ -127,4 +129,4 @@ The following arguments are supported:
127129
arguments. Ensure that the organization already exists prior to using this argument.
128130
This can also be specified using the `TfeOrganization` environment variable.
129131

130-
<!-- cache-key: cdktf-0.17.0-pre.15 input-98a93951706c0b637379a7e58fee89d9b8bf954524eb1ddd7ccfd3a3b284c053 -->
132+
<!-- cache-key: cdktf-0.17.0-pre.15 input-a5e1d5b687ea945c66490b8d5558c062336d41c52db56dadeb96156a725efed6 -->

‎website/docs/cdktf/csharp/r/project_policy_set.html.markdown‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_project_policy_set"
4+
description: |-
5+
Add a policy set to a project
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_project_policy_set
11+
12+
Adds and removes policy sets from a project
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
```hcl
19+
resource "tfe_organization" "test" {
20+
name = "my-org-name"
21+
email = "[email protected]"
22+
}
23+
24+
resource "tfe_project" "test" {
25+
name = "my-project-name"
26+
organization = tfe_organization.test.name
27+
}
28+
29+
resource "tfe_policy_set" "test" {
30+
name = "my-policy-set"
31+
description = "Some description."
32+
organization = tfe_organization.test.name
33+
}
34+
35+
resource "tfe_project_policy_set" "test" {
36+
policy_set_id = tfe_policy_set.test.id
37+
project_id = tfe_project.test.id
38+
}
39+
```
40+
41+
## Argument Reference
42+
43+
The following arguments are supported:
44+
45+
* `PolicySetId` - (Required) ID of the policy set.
46+
* `ProjectId` - (Required) Project ID to add the policy set to.
47+
48+
## Attributes Reference
49+
50+
* `Id` - The ID of the policy set attachment. ID format: `<project-id>_<policy-set-id>`
51+
52+
## Import
53+
54+
Project Policy Sets can be imported; use `<ORGANIZATION>/<PROJECT ID>/<POLICY SET NAME>`. For example:
55+
56+
```shell
57+
terraform import tfe_project_policy_set.test 'my-org-name/project/policy-set-name'
58+
```
59+
60+
<!-- cache-key: cdktf-0.17.0-pre.15 input-a94d4f5e615194b94eca988f334f60e46c27baa01749b25710f047ee6a038864 -->

‎website/docs/cdktf/csharp/r/saml_settings.html.markdown‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_saml_settings"
4+
description: |-
5+
Manages SAML Settings.
6+
---
7+
8+
9+
<!-- Please do not edit this file, it is generated. -->
10+
# tfe_saml_settings
11+
12+
Use this resource to create, update and destroy SAML Settings. It applies only to Terraform Enterprise and requires admin token configuration. See example usage for incorporating an admin token in your provider config.
13+
14+
## Example Usage
15+
16+
Basic usage for SAML Settings:
17+
18+
```hcl
19+
provider "tfe" {
20+
hostname = var.hostname
21+
token = var.admin_token
22+
}
23+
24+
resource "tfe_saml_settings" "this" {
25+
idp_cert = "foobarCertificate"
26+
slo_endpoint_url = "https://example.com/slo_endpoint_url"
27+
sso_endpoint_url = "https://example.com/sso_endpoint_url"
28+
}
29+
```
30+
31+
## Argument Reference
32+
33+
The following arguments are supported:
34+
35+
* `IdpCert` - (Required) Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.
36+
* `SloEndpointUrl` - (Required) Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests. This value is provided by the IdP configuration.
37+
* `SsoEndpointUrl` - (Required) Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests. This value is provided by the IdP configuration.
38+
* `Debug` - (Optional) When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.
39+
* `AuthnRequestsSigned` - (Optional) Whether to ensure that `<samlp:AuthnRequest>` messages are signed.
40+
* `WantAssertionsSigned` - (Optional) Whether to ensure that `<samlp:Assertion>` elements are signed.
41+
* `TeamManagementEnabled` - (Optional) Set it to false if you would rather use Terraform Enterprise to manage team membership.
42+
* `AttrUsername` - (Optional) Username Attribute Name specifies the name of the SAML attribute that determines the user's username.
43+
* `AttrSiteAdmin` - (Optional) Specifies the role for site admin access. Overrides the `Site Admin Role` method.
44+
* `AttrGroups` - (Optional) Team Attribute Name specifies the name of the SAML attribute that determines team membership.
45+
* `SiteAdminRole` - (Optional) Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.
46+
* `SsoApiTokenSessionTimeout` - (Optional) Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
47+
* `Certificate` - (Optional) The certificate used for request and assertion signing.
48+
* `PrivateKey` - (Optional) The private key used for request and assertion signing.
49+
* `SignatureSigningMethod` - (Optional) Signature Signing Method. Must be either `Sha1` or `Sha256`. Defaults to `Sha256`.
50+
* `SignatureDigestMethod` - (Optional) Signature Digest Method. Must be either `Sha1` or `Sha256`. Defaults to `Sha256`.
51+
52+
## Attributes Reference
53+
54+
* `Id` - The ID of the SAML Settings. Always `Saml`.
55+
* `AcsConsumerUrl` - ACS Consumer (Recipient) URL.
56+
* `MetadataUrl` - Metadata (Audience) URL.
57+
* `OldIdpCert` - Value of the old IDP Certificate.
58+
59+
## Import
60+
61+
SAML Settings can be imported.
62+
63+
```shell
64+
terraform import tfe_saml_settings.this saml
65+
```
66+
67+
<!-- cache-key: cdktf-0.17.0-pre.15 input-638ff2b3454a9c98199c9259ef06e339ead03786f80128a77130cb8fde31700e -->

‎website/docs/cdktf/csharp/r/team_project_access.html.markdown‎

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Associate a team to permissions on a project.
66
---
77

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

1012
Associate a team to permissions on a project.
@@ -49,7 +51,82 @@ The following arguments are supported:
4951

5052
* `TeamId` - (Required) ID of the team to add to the project.
5153
* `ProjectId` - (Required) ID of the project to which the team will be added.
52-
* `Access` - (Required) Type of fixed access to grant. Valid values are `Admin`, `Maintain`, `Write`, or `Read`.
54+
* `Access` - (Required) Type of fixed access to grant. Valid values are `Admin`, `Maintain`, `Write`, `Read`, or `Custom`.
55+
56+
## Custom Access
57+
58+
If using `Custom` for `Access`, you can set the levels of individual permissions
59+
that affect the project itself and all workspaces in the project, by using `ProjectAccess` and `WorkspaceAccess` arguments and their associated permission attributes. When using custom access, if attributes are not set they will be given a default value. Some permissions have values that are specific "strings" that denote the level of the permission, while other permissions are simple booleans.
60+
61+
The following permissions apply to the project itself.
62+
63+
| project-access | Description, Default, Valid Values |
64+
|---------------------|---------------------------------------------|
65+
| `Settings` | The permission to grant for the project's settings. Default: `Read`. Valid strings: `Read`, `Update`, or `Delete` |
66+
| `Teams` | The permission to grant for the project's teams. Default: `None`, Valid strings: `None`, `Read`, or `Manage` |
67+
68+
</n>
69+
</n>
70+
</n>
71+
72+
The following permissions apply to all workpsaces (and future workspaces) in the project.
73+
74+
| workspace-access | Description, Default, Valid Values |
75+
|----------------------|-------------------------------------------------------|
76+
| `Runs` | The permission to grant project's workspaces' runs. Default: `Read`. Valid strings: `Read`, `Plan`, or `Apply`. |
77+
| `SentinelMocks` | The permission to grant project's workspaces' Sentinel mocks. Default: `None`. Valid strings: `None`, or `Read`. |
78+
| `StateVersions` | The permission to grant project's workspaces' state versions. Default: `None` Valid strings: `None`, `ReadOutputs`, `Read`, or `Write`.|
79+
| `Variables` | The permission to grant project's workspaces' variables. Default `None`. Valid strings: `None`, `Read`, or `Write`. |
80+
| `Create` | The permission to create project's workspaces in the project. Default: `False`. Valid booleans `True`, `False` |
81+
| `Locking` | The permission to manually lock or unlock the project's workspaces. Default `False`. Valid booleans `True`, `False` |
82+
| `Delete` | The permission to delete the project's workspaces. Default: `False`. Valid booleans: `True`, `False` |
83+
| `Move` | This permission to move workspaces into and out of the project. The team must also have permissions to the project(s) receiving the the workspace(s). Default: `False`. Valid booleans: `True`, `False` |
84+
| `RunTasks` | The permission to manage run tasks within the project's workspaces. Default `False`. Valid booleans: `True`, `False` |
85+
86+
87+
## Example Usage with Custom Project Permissions
88+
89+
```csharp
90+
using Constructs;
91+
using HashiCorp.Cdktf;
92+
/*Provider bindings are generated by running cdktf get.
93+
See https://cdk.tf/provider-generation for more details.*/
94+
using Gen.Providers.Tfe;
95+
class MyConvertedCode : TerraformStack
96+
{
97+
public MyConvertedCode(Construct scope, string name) : base(scope, name)
98+
{
99+
var tfeProjectTest = new Project.Project(this, "test", new ProjectConfig {
100+
Name = "myproject",
101+
Organization = "my-org-name"
102+
});
103+
var tfeTeamDev = new Team.Team(this, "dev", new TeamConfig {
104+
Name = "my-dev-team",
105+
Organization = "my-org-name"
106+
});
107+
new TeamProjectAccess.TeamProjectAccess(this, "custom", new TeamProjectAccessConfig {
108+
Access = "custom",
109+
ProjectAccess = new [] { new Struct {
110+
Settings = "read",
111+
Teams = "none"
112+
} },
113+
ProjectId = Token.AsString(tfeProjectTest.Id),
114+
TeamId = Token.AsString(tfeTeamDev.Id),
115+
WorkspaceAccess = new [] { new Struct {
116+
Create = true,
117+
Delete = false,
118+
Locking = true,
119+
Move = false,
120+
RunTasks = false,
121+
Runs = "apply",
122+
SentinelMocks = "none",
123+
StateVersions = "write",
124+
Variables = "write"
125+
} }
126+
});
127+
}
128+
}
129+
```
53130

54131
## Attributes Reference
55132

@@ -64,4 +141,4 @@ example:
64141
terraform import tfe_team_project_access.admin tprj-2pmtXpZa4YzVMTPi
65142
```
66143

67-
<!-- cache-key: cdktf-0.17.0-pre.15 input-6077af17aff449bdcfb81f649aba3c085dccfd367de7cedd899696f602bd0c83 -->
144+
<!-- cache-key: cdktf-0.17.0-pre.15 input-59adea41bbc7af7bc7a002d9559654563be61c40bff73cd4d03e018ea34597df -->

‎website/docs/cdktf/go/d/policy_set.html.markdown‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on organization policy sets.
66
---
77

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

1012
This data source is used to retrieve a policy set defined in a specified organization.
@@ -51,6 +53,7 @@ The following arguments are supported:
5153
* `Kind` - The policy-as-code framework for the policy. Valid values are "sentinel" and "opa".
5254
* `Overridable` - Whether users can override this policy when it fails during a run. Only valid for OPA policies.
5355
* `WorkspaceIds` - IDs of the workspaces that use the policy set.
56+
* `ProjectIds` - IDs of the projects that use the policy set.
5457
* `PolicyIds` - IDs of the policies attached to the policy set.
5558
* `PoliciesPath` - The sub-path within the attached VCS repository when using `VcsRepo`.
5659
* `VcsRepo` - Settings for the workspace's VCS repository.
@@ -66,4 +69,4 @@ The `VcsRepo` block contains:
6669
* `OauthTokenId` - OAuth token ID of the configured VCS connection.
6770

6871

69-
<!-- cache-key: cdktf-0.17.0-pre.15 input-369a7ffb16c0ab83ebbbde324972bb3020c1f6cf5bfbf759dc0563f1d5a4b8b1 -->
72+
<!-- cache-key: cdktf-0.17.0-pre.15 input-54cb92dfae22abe76f4a8306daadcae6353d03b00d72dfbb74c8950c625507e0 -->

0 commit comments

Comments
 (0)