Skip to content

Commit 4764734

Browse files
authored
Merge pull request #1016 from hashicorp/d-cdktf-docs-5903530461-30
cdktf: update documentation
2 parents 07d7878 + 1faef51 commit 4764734

File tree

130 files changed

+458
-320
lines changed

Some content is hidden

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

130 files changed

+458
-320
lines changed

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

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

1616
```python
17-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
1919
from cdktf import TerraformStack
2020
#
@@ -45,4 +45,4 @@ In addition to all arguments above, the following attributes are exported:
4545
* `id` - The agent pool ID.
4646
* `organization_scoped` - Whether or not the agent pool can be used by all workspaces in the organization.
4747

48-
<!-- cache-key: cdktf-0.17.1 input-b223e1934ef43efb927b0566eadbb97c45112079ed23b335806e0098961b16f3 -->
48+
<!-- cache-key: cdktf-0.18.0 input-b223e1934ef43efb927b0566eadbb97c45112079ed23b335806e0098961b16f3 -->

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Use this data source to get information about the Github App Installation.
1616
### Finding a Github App Installation by its installation ID
1717

1818
```python
19-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
19+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
2020
from constructs import Construct
2121
from cdktf import TerraformStack
2222
#
@@ -35,7 +35,7 @@ class MyConvertedCode(TerraformStack):
3535
### Finding a Github App Installation by its name
3636

3737
```python
38-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
38+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
3939
from constructs import Construct
4040
from cdktf import TerraformStack
4141
#
@@ -65,4 +65,4 @@ Must be one of: `installation_id` or `name`.
6565
In addition to all arguments above, the following attributes are exported:
6666

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more
1414
## Example Usage
1515

1616
```python
17-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
1919
from cdktf import TerraformOutput, TerraformStack
2020
#
@@ -45,4 +45,4 @@ The following attributes are exported:
4545
* `vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers.
4646

4747

48-
<!-- cache-key: cdktf-0.17.1 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->
48+
<!-- cache-key: cdktf-0.18.0 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Use this data source to get information about an OAuth client.
1616
### Finding an OAuth client by its ID
1717

1818
```python
19-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
19+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
2020
from constructs import Construct
2121
from cdktf import TerraformStack
2222
#
@@ -35,7 +35,7 @@ class MyConvertedCode(TerraformStack):
3535
### Finding an OAuth client by its name
3636

3737
```python
38-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
38+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
3939
from constructs import Construct
4040
from cdktf import TerraformStack
4141
#
@@ -55,7 +55,7 @@ class MyConvertedCode(TerraformStack):
5555
### Finding an OAuth client by its service provider
5656

5757
```python
58-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
58+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
5959
from constructs import Construct
6060
from cdktf import TerraformStack
6161
#
@@ -102,4 +102,4 @@ In addition to all arguments above, the following attributes are exported:
102102
* `service_provider` - The API identifier of the OAuth service provider.
103103
* `service_provider_display_name` - The display name of the OAuth service provider.
104104

105-
<!-- cache-key: cdktf-0.17.1 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->
105+
<!-- cache-key: cdktf-0.18.0 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->

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

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

1616
```python
17-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
1919
from cdktf import TerraformStack
2020
#
@@ -48,4 +48,4 @@ In addition to all arguments above, the following attributes are exported:
4848
* `owners_team_saml_role_id` - The name of the "owners" team.
4949
* `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.
5050
* `default_project_id` - ID of the organization's default project. All workspaces created without specifying a project ID are created in this project.
51-
<!-- cache-key: cdktf-0.17.1 input-73ec7085b3dbf61a45984fb7c74bac9c042ca20c175259f0650faf7acfa99133 -->
51+
<!-- cache-key: cdktf-0.18.0 input-73ec7085b3dbf61a45984fb7c74bac9c042ca20c175259f0650faf7acfa99133 -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use this data source to get information about members of an organization.
1414
## Example Usage
1515

1616
```python
17-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
1919
from cdktf import TerraformStack
2020
#
@@ -52,4 +52,4 @@ The `member` block contains:
5252

5353
* `user_id` - The ID of the user.
5454
* `organization_membership_id` - The ID of the organization membership.
55-
<!-- cache-key: cdktf-0.17.1 input-4c032c533c9de727b2406429de451318455dd383062b352da22d3b516529bb5b -->
55+
<!-- cache-key: cdktf-0.18.0 input-4c032c533c9de727b2406429de451318455dd383062b352da22d3b516529bb5b -->

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

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ be updated manually.
2222
### Fetch by email
2323

2424
```python
25-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
25+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
2626
from constructs import Construct
2727
from cdktf import TerraformStack
2828
#
@@ -42,7 +42,7 @@ class MyConvertedCode(TerraformStack):
4242
### Fetch by username
4343

4444
```python
45-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
45+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
4646
from constructs import Construct
4747
from cdktf import TerraformStack
4848
#
@@ -59,15 +59,36 @@ class MyConvertedCode(TerraformStack):
5959
)
6060
```
6161

62+
### Fetch by organization membership ID
63+
64+
```python
65+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
66+
from constructs import Construct
67+
from cdktf import TerraformStack
68+
#
69+
# Provider bindings are generated by running `cdktf get`.
70+
# See https://cdk.tf/provider-generation for more details.
71+
#
72+
from imports.tfe.data_tfe_organization_membership import DataTfeOrganizationMembership
73+
class MyConvertedCode(TerraformStack):
74+
def __init__(self, scope, name):
75+
super().__init__(scope, name)
76+
DataTfeOrganizationMembership(self, "test",
77+
organization="my-org-name",
78+
organization_membership_id="ou-xxxxxxxxxxx"
79+
)
80+
```
81+
6282
## Argument Reference
6383

6484
The following arguments are supported:
6585

66-
* `organization` - (Required) Name of the organization.
86+
* `organization` - (Optional) Name of the organization.
6787
* `email` - (Optional) Email of the user.
6888
* `username` - (Optional) The username of the user.
89+
* `organization_membership_id` - (Optional) ID belonging to the organziation membership.
6990

70-
~> **NOTE:** While `email` and `username` are optional arguments, one or the other is required.
91+
~> **NOTE:** While `email` and `username` are optional arguments, one or the other is required if `organization_membership_id` argument is not provided.
7192

7293
## Attributes Reference
7394

@@ -77,4 +98,4 @@ In addition to all arguments above, the following attributes are exported:
7798
* `user_id` - The ID of the user associated with the organization membership.
7899
* `username` - The username of the user associated with the organization membership.
79100

80-
<!-- cache-key: cdktf-0.17.1 input-4a14b3c66d2d0654b6af772796f3c1bdf8871760782092fd770887fd1a21bb84 -->
101+
<!-- cache-key: cdktf-0.18.0 input-d0160d0a09a0b3ce6035db02657e5b320810e469cbd9da4ae71b7158b313258f -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Use this data source to get information about an [Organization Run tasks](https:
1616
## Example Usage
1717

1818
```python
19-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
19+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
2020
from constructs import Construct
2121
from cdktf import TerraformStack
2222
#
@@ -50,4 +50,4 @@ In addition to all arguments above, the following attributes are exported:
5050
* `id` - The ID of the task.
5151
* `url` - URL to send a task payload.
5252

53-
<!-- cache-key: cdktf-0.17.1 input-7ffa3170dbbf69fd581f515eab6eaac9c5c936b21ba712b8803b32966fbb628c -->
53+
<!-- cache-key: cdktf-0.18.0 input-7ffa3170dbbf69fd581f515eab6eaac9c5c936b21ba712b8803b32966fbb628c -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use this data source to get information about the workspace tags for a given org
1414
## Example Usage
1515

1616
```python
17-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
1919
from cdktf import TerraformStack
2020
#
@@ -47,4 +47,4 @@ The `tag` block contains:
4747
* `name` - The name of the workspace tag
4848
* `id` - The ID of the workspace tag
4949
* `workspace_count` - The number of workspaces the tag is associate with
50-
<!-- cache-key: cdktf-0.17.1 input-d15c1053d1d117c26eeb6475e9ca3ddc3aafc7a038a9de059581cc65071f7b11 -->
50+
<!-- cache-key: cdktf-0.18.0 input-d15c1053d1d117c26eeb6475e9ca3ddc3aafc7a038a9de059581cc65071f7b11 -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use this data source to get a list of Organizations and a map of their IDs.
1414
## Example Usage
1515

1616
```python
17-
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
17+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
1818
from constructs import Construct
1919
from cdktf import TerraformStack
2020
#
@@ -44,4 +44,4 @@ The following attributes are exported:
4444
* `names` - A list of names of every organization.
4545
* `ids` - A map of organization names and their IDs.
4646

47-
<!-- cache-key: cdktf-0.17.1 input-354a91021f4f79c63498ca2f5ff88c87a3b80ebfa8571ca6f38023f333a05e12 -->
47+
<!-- cache-key: cdktf-0.18.0 input-354a91021f4f79c63498ca2f5ff88c87a3b80ebfa8571ca6f38023f333a05e12 -->

0 commit comments

Comments
 (0)