Skip to content

Commit cf9e146

Browse files
authored
Merge pull request #1004 from hashicorp/d-cdktf-docs-5855965717-24
cdktf: update documentation
2 parents 46cce5a + 47b5416 commit cf9e146

File tree

128 files changed

+3456
-2568
lines changed

Some content is hidden

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

128 files changed

+3456
-2568
lines changed

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

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,18 @@ Use this data source to get information about an agent pool.
1414
## Example Usage
1515

1616
```python
17-
import constructs as constructs
18-
import cdktf as cdktf
19-
# Provider bindings are generated by running cdktf get.
17+
# 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`.
2022
# See https://cdk.tf/provider-generation for more details.
21-
import ...gen.providers.tfe as tfe
22-
class MyConvertedCode(cdktf.TerraformStack):
23+
#
24+
from imports.tfe.data_tfe_agent_pool import DataTfeAgentPool
25+
class MyConvertedCode(TerraformStack):
2326
def __init__(self, scope, name):
2427
super().__init__(scope, name)
25-
tfe.data_tfe_agent_pool.DataTfeAgentPool(self, "test",
28+
DataTfeAgentPool(self, "test",
2629
name="my-agent-pool-name",
2730
organization="my-org-name"
2831
)
@@ -42,4 +45,4 @@ In addition to all arguments above, the following attributes are exported:
4245
* `id` - The agent pool ID.
4346
* `organization_scoped` - Whether or not the agent pool can be used by all workspaces in the organization.
4447

45-
<!-- cache-key: cdktf-0.17.0-pre.15 input-b223e1934ef43efb927b0566eadbb97c45112079ed23b335806e0098961b16f3 -->
48+
<!-- cache-key: cdktf-0.17.1 input-b223e1934ef43efb927b0566eadbb97c45112079ed23b335806e0098961b16f3 -->

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

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on the Github App Installation.
66
---
77

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

1012
Use this data source to get information about the Github App Installation.
@@ -14,31 +16,37 @@ Use this data source to get information about the Github App Installation.
1416
### Finding a Github App Installation by its installation ID
1517

1618
```python
17-
import constructs as constructs
18-
import cdktf as cdktf
19-
# Provider bindings are generated by running cdktf get.
19+
# 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`.
2024
# See https://cdk.tf/provider-generation for more details.
21-
import ...gen.providers.tfe as tfe
22-
class MyConvertedCode(cdktf.TerraformStack):
25+
#
26+
from imports.tfe.data_tfe_github_app_installation import DataTfeGithubAppInstallation
27+
class MyConvertedCode(TerraformStack):
2328
def __init__(self, scope, name):
2429
super().__init__(scope, name)
25-
tfe.data_tfe_github_app_installation.DataTfeGithubAppInstallation(self, "gha_installation",
30+
DataTfeGithubAppInstallation(self, "gha_installation",
2631
installation_id=12345
2732
)
2833
```
2934

3035
### Finding a Github App Installation by its name
3136

3237
```python
33-
import constructs as constructs
34-
import cdktf as cdktf
35-
# Provider bindings are generated by running cdktf get.
38+
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
39+
from constructs import Construct
40+
from cdktf import TerraformStack
41+
#
42+
# Provider bindings are generated by running `cdktf get`.
3643
# See https://cdk.tf/provider-generation for more details.
37-
import ...gen.providers.tfe as tfe
38-
class MyConvertedCode(cdktf.TerraformStack):
44+
#
45+
from imports.tfe.data_tfe_github_app_installation import DataTfeGithubAppInstallation
46+
class MyConvertedCode(TerraformStack):
3947
def __init__(self, scope, name):
4048
super().__init__(scope, name)
41-
tfe.data_tfe_github_app_installation.DataTfeGithubAppInstallation(self, "gha_installation",
49+
DataTfeGithubAppInstallation(self, "gha_installation",
4250
name="installation_name"
4351
)
4452
```
@@ -57,4 +65,4 @@ Must be one of: `installation_id` or `name`.
5765
In addition to all arguments above, the following attributes are exported:
5866

5967
* `id` - The internal ID of the Github Installation. This is different from the `installation_id`.
60-
<!-- cache-key: cdktf-0.17.0-pre.15 input-0a4ff055d60c44b213a5dc7ce9fcb8c10208e9d24cd4e44f3a552a718ea64d50 -->
68+
<!-- cache-key: cdktf-0.17.1 input-0a4ff055d60c44b213a5dc7ce9fcb8c10208e9d24cd4e44f3a552a718ea64d50 -->

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

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,29 @@ description: |-
55
Get Terraform Cloud/Enterprise's IP ranges of its services
66
---
77

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

1012
Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges).
1113

1214
## Example Usage
1315

1416
```python
15-
import constructs as constructs
16-
import cdktf as cdktf
17-
# Provider bindings are generated by running cdktf get.
17+
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
18+
from constructs import Construct
19+
from cdktf import TerraformOutput, TerraformStack
20+
#
21+
# Provider bindings are generated by running `cdktf get`.
1822
# See https://cdk.tf/provider-generation for more details.
19-
import ...gen.providers.tfe as tfe
20-
class MyConvertedCode(cdktf.TerraformStack):
23+
#
24+
from imports.tfe.data_tfe_ip_ranges import DataTfeIpRanges
25+
class MyConvertedCode(TerraformStack):
2126
def __init__(self, scope, name):
2227
super().__init__(scope, name)
23-
data_tfe_ip_ranges_addresses = tfe.data_tfe_ip_ranges.DataTfeIpRanges(self, "addresses")
24-
cdktf.TerraformOutput(self, "notifications_ips",
25-
value=data_tfe_ip_ranges_addresses.notifications
28+
addresses = DataTfeIpRanges(self, "addresses")
29+
TerraformOutput(self, "notifications_ips",
30+
value=addresses.notifications
2631
)
2732
```
2833

@@ -40,4 +45,4 @@ The following attributes are exported:
4045
* `vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers.
4146

4247

43-
<!-- cache-key: cdktf-0.17.0-pre.15 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->
48+
<!-- cache-key: cdktf-0.17.1 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->

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

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on an OAuth client.
66
---
77

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

1012
Use this data source to get information about an OAuth client.
@@ -14,31 +16,37 @@ Use this data source to get information about an OAuth client.
1416
### Finding an OAuth client by its ID
1517

1618
```python
17-
import constructs as constructs
18-
import cdktf as cdktf
19-
# Provider bindings are generated by running cdktf get.
19+
# 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`.
2024
# See https://cdk.tf/provider-generation for more details.
21-
import ...gen.providers.tfe as tfe
22-
class MyConvertedCode(cdktf.TerraformStack):
25+
#
26+
from imports.tfe.data_tfe_oauth_client import DataTfeOauthClient
27+
class MyConvertedCode(TerraformStack):
2328
def __init__(self, scope, name):
2429
super().__init__(scope, name)
25-
tfe.data_tfe_oauth_client.DataTfeOauthClient(self, "client",
30+
DataTfeOauthClient(self, "client",
2631
oauth_client_id="oc-XXXXXXX"
2732
)
2833
```
2934

3035
### Finding an OAuth client by its name
3136

3237
```python
33-
import constructs as constructs
34-
import cdktf as cdktf
35-
# Provider bindings are generated by running cdktf get.
38+
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
39+
from constructs import Construct
40+
from cdktf import TerraformStack
41+
#
42+
# Provider bindings are generated by running `cdktf get`.
3643
# See https://cdk.tf/provider-generation for more details.
37-
import ...gen.providers.tfe as tfe
38-
class MyConvertedCode(cdktf.TerraformStack):
44+
#
45+
from imports.tfe.data_tfe_oauth_client import DataTfeOauthClient
46+
class MyConvertedCode(TerraformStack):
3947
def __init__(self, scope, name):
4048
super().__init__(scope, name)
41-
tfe.data_tfe_oauth_client.DataTfeOauthClient(self, "client",
49+
DataTfeOauthClient(self, "client",
4250
name="my-oauth-client",
4351
organization="my-org"
4452
)
@@ -47,15 +55,18 @@ class MyConvertedCode(cdktf.TerraformStack):
4755
### Finding an OAuth client by its service provider
4856

4957
```python
50-
import constructs as constructs
51-
import cdktf as cdktf
52-
# Provider bindings are generated by running cdktf get.
58+
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
59+
from constructs import Construct
60+
from cdktf import TerraformStack
61+
#
62+
# Provider bindings are generated by running `cdktf get`.
5363
# See https://cdk.tf/provider-generation for more details.
54-
import ...gen.providers.tfe as tfe
55-
class MyConvertedCode(cdktf.TerraformStack):
64+
#
65+
from imports.tfe.data_tfe_oauth_client import DataTfeOauthClient
66+
class MyConvertedCode(TerraformStack):
5667
def __init__(self, scope, name):
5768
super().__init__(scope, name)
58-
tfe.data_tfe_oauth_client.DataTfeOauthClient(self, "client",
69+
DataTfeOauthClient(self, "client",
5970
organization="my-org",
6071
service_provider="github"
6172
)
@@ -91,4 +102,4 @@ In addition to all arguments above, the following attributes are exported:
91102
* `service_provider` - The API identifier of the OAuth service provider.
92103
* `service_provider_display_name` - The display name of the OAuth service provider.
93104

94-
<!-- cache-key: cdktf-0.17.0-pre.15 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->
105+
<!-- cache-key: cdktf-0.17.1 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,27 @@ description: |-
55
Get information on an Organization.
66
---
77

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

1012
Use this data source to get information about an organization.
1113

1214
## Example Usage
1315

1416
```python
15-
import constructs as constructs
16-
import cdktf as cdktf
17-
# Provider bindings are generated by running cdktf get.
17+
# 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`.
1822
# See https://cdk.tf/provider-generation for more details.
19-
import ...gen.providers.tfe as tfe
20-
class MyConvertedCode(cdktf.TerraformStack):
23+
#
24+
from imports.tfe.data_tfe_organization import DataTfeOrganization
25+
class MyConvertedCode(TerraformStack):
2126
def __init__(self, scope, name):
2227
super().__init__(scope, name)
23-
tfe.data_tfe_organization.DataTfeOrganization(self, "foo",
28+
DataTfeOrganization(self, "foo",
2429
name="organization-name"
2530
)
2631
```
@@ -43,4 +48,4 @@ In addition to all arguments above, the following attributes are exported:
4348
* `owners_team_saml_role_id` - The name of the "owners" team.
4449
* `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.
4550
* `default_project_id` - ID of the organization's default project. All workspaces created without specifying a project ID are created in this project.
46-
<!-- cache-key: cdktf-0.17.0-pre.15 input-73ec7085b3dbf61a45984fb7c74bac9c042ca20c175259f0650faf7acfa99133 -->
51+
<!-- cache-key: cdktf-0.17.1 input-73ec7085b3dbf61a45984fb7c74bac9c042ca20c175259f0650faf7acfa99133 -->

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

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,33 @@ description: |-
55
Get information on an Organization members.
66
---
77

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

1012
Use this data source to get information about members of an organization.
1113

1214
## Example Usage
1315

1416
```python
15-
import constructs as constructs
16-
import cdktf as cdktf
17-
# Provider bindings are generated by running cdktf get.
17+
# 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`.
1822
# See https://cdk.tf/provider-generation for more details.
19-
import ...gen.providers.tfe as tfe
20-
class MyConvertedCode(cdktf.TerraformStack):
23+
#
24+
from imports.tfe.data_tfe_organization_members import DataTfeOrganizationMembers
25+
from imports.tfe.organization import Organization
26+
class MyConvertedCode(TerraformStack):
2127
def __init__(self, scope, name):
2228
super().__init__(scope, name)
23-
tfe_organization_bar = tfe.organization.Organization(self, "bar",
29+
bar = Organization(self, "bar",
2430
2531
name="org-bar"
2632
)
27-
tfe.data_tfe_organization_members.DataTfeOrganizationMembers(self, "foo",
28-
organization=cdktf.Token.as_string(tfe_organization_bar.name)
33+
DataTfeOrganizationMembers(self, "foo",
34+
organization=bar.name
2935
)
3036
```
3137

@@ -46,4 +52,4 @@ The `member` block contains:
4652

4753
* `user_id` - The ID of the user.
4854
* `organization_membership_id` - The ID of the organization membership.
49-
<!-- cache-key: cdktf-0.17.0-pre.15 input-4c032c533c9de727b2406429de451318455dd383062b352da22d3b516529bb5b -->
55+
<!-- cache-key: cdktf-0.17.1 input-4c032c533c9de727b2406429de451318455dd383062b352da22d3b516529bb5b -->

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

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: |-
55
Get information on an organization membership.
66
---
77

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

1012
Use this data source to get information about an organization membership.
@@ -20,15 +22,18 @@ be updated manually.
2022
### Fetch by email
2123

2224
```python
23-
import constructs as constructs
24-
import cdktf as cdktf
25-
# Provider bindings are generated by running cdktf get.
25+
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
26+
from constructs import Construct
27+
from cdktf import TerraformStack
28+
#
29+
# Provider bindings are generated by running `cdktf get`.
2630
# See https://cdk.tf/provider-generation for more details.
27-
import ...gen.providers.tfe as tfe
28-
class MyConvertedCode(cdktf.TerraformStack):
31+
#
32+
from imports.tfe.data_tfe_organization_membership import DataTfeOrganizationMembership
33+
class MyConvertedCode(TerraformStack):
2934
def __init__(self, scope, name):
3035
super().__init__(scope, name)
31-
tfe.data_tfe_organization_membership.DataTfeOrganizationMembership(self, "test",
36+
DataTfeOrganizationMembership(self, "test",
3237
3338
organization="my-org-name"
3439
)
@@ -37,15 +42,18 @@ class MyConvertedCode(cdktf.TerraformStack):
3742
### Fetch by username
3843

3944
```python
40-
import constructs as constructs
41-
import cdktf as cdktf
42-
# Provider bindings are generated by running cdktf get.
45+
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
46+
from constructs import Construct
47+
from cdktf import TerraformStack
48+
#
49+
# Provider bindings are generated by running `cdktf get`.
4350
# See https://cdk.tf/provider-generation for more details.
44-
import ...gen.providers.tfe as tfe
45-
class MyConvertedCode(cdktf.TerraformStack):
51+
#
52+
from imports.tfe.data_tfe_organization_membership import DataTfeOrganizationMembership
53+
class MyConvertedCode(TerraformStack):
4654
def __init__(self, scope, name):
4755
super().__init__(scope, name)
48-
tfe.data_tfe_organization_membership.DataTfeOrganizationMembership(self, "test",
56+
DataTfeOrganizationMembership(self, "test",
4957
organization="my-org-name",
5058
username="my-username"
5159
)
@@ -69,4 +77,4 @@ In addition to all arguments above, the following attributes are exported:
6977
* `user_id` - The ID of the user associated with the organization membership.
7078
* `username` - The username of the user associated with the organization membership.
7179

72-
<!-- cache-key: cdktf-0.17.0-pre.15 input-4a14b3c66d2d0654b6af772796f3c1bdf8871760782092fd770887fd1a21bb84 -->
80+
<!-- cache-key: cdktf-0.17.1 input-4a14b3c66d2d0654b6af772796f3c1bdf8871760782092fd770887fd1a21bb84 -->

0 commit comments

Comments
 (0)