Skip to content

Commit

Permalink
Merge pull request #1140 from hashicorp/d-cdktf-docs-6843977216-44
Browse files Browse the repository at this point in the history 
cdktf: update documentation
  • Loading branch information
@brandonc
brandonc authored Nov 13, 2023
2 parents 136a2fe + c25f4dd commit 74c0a31
Show file tree
Hide file tree
Showing 132 changed files with 3,420 additions and 2,768 deletions.
17 changes: 10 additions & 7 deletions website/docs/cdktf/python/d/agent_pool.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,18 @@ Use this data source to get information about an agent pool.
## Example Usage

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_agent_pool import DataTfeAgentPool
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_agent_pool.DataTfeAgentPool(self, "test",
DataTfeAgentPool(self, "test",
name="my-agent-pool-name",
organization="my-org-name"
)
Expand All @@ -42,4 +45,4 @@ In addition to all arguments above, the following attributes are exported:
* `id` - The agent pool ID.
* `organization_scoped` - Whether or not the agent pool can be used by all workspaces in the organization.

<!-- cache-key: cdktf-0.17.0-pre.15 input-b223e1934ef43efb927b0566eadbb97c45112079ed23b335806e0098961b16f3 -->
<!-- cache-key: cdktf-0.19.0 input-b223e1934ef43efb927b0566eadbb97c45112079ed23b335806e0098961b16f3 -->
32 changes: 19 additions & 13 deletions website/docs/cdktf/python/d/github_installation.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,37 @@ Use this data source to get information about the Github App Installation.
### Finding a Github App Installation by its installation ID

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_github_app_installation import DataTfeGithubAppInstallation
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_github_app_installation.DataTfeGithubAppInstallation(self, "gha_installation",
DataTfeGithubAppInstallation(self, "gha_installation",
installation_id=12345
)
```

### Finding a Github App Installation by its name

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_github_app_installation import DataTfeGithubAppInstallation
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_github_app_installation.DataTfeGithubAppInstallation(self, "gha_installation",
DataTfeGithubAppInstallation(self, "gha_installation",
name="installation_name"
)
```
Expand All @@ -59,4 +65,4 @@ Must be one of: `installation_id` or `name`.
In addition to all arguments above, the following attributes are exported:

* `id` - The internal ID of the Github Installation. This is different from the `installation_id`.
<!-- cache-key: cdktf-0.17.0-pre.15 input-0a4ff055d60c44b213a5dc7ce9fcb8c10208e9d24cd4e44f3a552a718ea64d50 -->
<!-- cache-key: cdktf-0.19.0 input-0a4ff055d60c44b213a5dc7ce9fcb8c10208e9d24cd4e44f3a552a718ea64d50 -->
21 changes: 12 additions & 9 deletions website/docs/cdktf/python/d/ip_ranges.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,20 @@ Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more
## Example Usage

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformOutput, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_ip_ranges import DataTfeIpRanges
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
data_tfe_ip_ranges_addresses = tfe.data_tfe_ip_ranges.DataTfeIpRanges(self, "addresses")
cdktf.TerraformOutput(self, "notifications_ips",
value=data_tfe_ip_ranges_addresses.notifications
addresses = DataTfeIpRanges(self, "addresses")
TerraformOutput(self, "notifications_ips",
value=addresses.notifications
)
```

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


<!-- cache-key: cdktf-0.17.0-pre.15 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->
<!-- cache-key: cdktf-0.19.0 input-a34895b98b3769147c0512ab50d1c1788daf43f5ff3206286266831c516fc66b -->
47 changes: 28 additions & 19 deletions website/docs/cdktf/python/d/oauth_client.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,37 @@ Use this data source to get information about an OAuth client.
### Finding an OAuth client by its ID

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_oauth_client import DataTfeOauthClient
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_oauth_client.DataTfeOauthClient(self, "client",
DataTfeOauthClient(self, "client",
oauth_client_id="oc-XXXXXXX"
)
```

### Finding an OAuth client by its name

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_oauth_client import DataTfeOauthClient
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_oauth_client.DataTfeOauthClient(self, "client",
DataTfeOauthClient(self, "client",
name="my-oauth-client",
organization="my-org"
)
Expand All @@ -49,15 +55,18 @@ class MyConvertedCode(cdktf.TerraformStack):
### Finding an OAuth client by its service provider

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_oauth_client import DataTfeOauthClient
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_oauth_client.DataTfeOauthClient(self, "client",
DataTfeOauthClient(self, "client",
organization="my-org",
service_provider="github"
)
Expand Down Expand Up @@ -93,4 +102,4 @@ In addition to all arguments above, the following attributes are exported:
* `service_provider` - The API identifier of the OAuth service provider.
* `service_provider_display_name` - The display name of the OAuth service provider.

<!-- cache-key: cdktf-0.17.0-pre.15 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->
<!-- cache-key: cdktf-0.19.0 input-59b4bcbbb310e7ee913a245f3c751829442542dbcf1bbb4c87ac286043b69348 -->
17 changes: 10 additions & 7 deletions website/docs/cdktf/python/d/organization.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,18 @@ Use this data source to get information about an organization.
## Example Usage

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_organization import DataTfeOrganization
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_organization.DataTfeOrganization(self, "foo",
DataTfeOrganization(self, "foo",
name="organization-name"
)
```
Expand All @@ -45,4 +48,4 @@ In addition to all arguments above, the following attributes are exported:
* `owners_team_saml_role_id` - The name of the "owners" team.
* `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.
* `default_project_id` - ID of the organization's default project. All workspaces created without specifying a project ID are created in this project.
<!-- cache-key: cdktf-0.17.0-pre.15 input-73ec7085b3dbf61a45984fb7c74bac9c042ca20c175259f0650faf7acfa99133 -->
<!-- cache-key: cdktf-0.19.0 input-73ec7085b3dbf61a45984fb7c74bac9c042ca20c175259f0650faf7acfa99133 -->
22 changes: 13 additions & 9 deletions website/docs/cdktf/python/d/organization_members.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,24 @@ Use this data source to get information about members of an organization.
## Example Usage

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_organization_members import DataTfeOrganizationMembers
from imports.tfe.organization import Organization
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe_organization_bar = tfe.organization.Organization(self, "bar",
bar = Organization(self, "bar",
email="[email protected]",
name="org-bar"
)
tfe.data_tfe_organization_members.DataTfeOrganizationMembers(self, "foo",
organization=cdktf.Token.as_string(tfe_organization_bar.name)
DataTfeOrganizationMembers(self, "foo",
organization=bar.name
)
```

Expand All @@ -48,4 +52,4 @@ The `member` block contains:

* `user_id` - The ID of the user.
* `organization_membership_id` - The ID of the organization membership.
<!-- cache-key: cdktf-0.17.0-pre.15 input-4c032c533c9de727b2406429de451318455dd383062b352da22d3b516529bb5b -->
<!-- cache-key: cdktf-0.19.0 input-4c032c533c9de727b2406429de451318455dd383062b352da22d3b516529bb5b -->
47 changes: 28 additions & 19 deletions website/docs/cdktf/python/d/organization_membership.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,18 @@ be updated manually.
### Fetch by email

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_organization_membership import DataTfeOrganizationMembership
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_organization_membership.DataTfeOrganizationMembership(self, "test",
DataTfeOrganizationMembership(self, "test",
email="[email protected]",
organization="my-org-name"
)
Expand All @@ -39,15 +42,18 @@ class MyConvertedCode(cdktf.TerraformStack):
### Fetch by username

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_organization_membership import DataTfeOrganizationMembership
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_organization_membership.DataTfeOrganizationMembership(self, "test",
DataTfeOrganizationMembership(self, "test",
organization="my-org-name",
username="my-username"
)
Expand All @@ -56,15 +62,18 @@ class MyConvertedCode(cdktf.TerraformStack):
### Fetch by organization membership ID

```python
import constructs as constructs
import cdktf as cdktf
# Provider bindings are generated by running cdktf get.
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
import ...gen.providers.tfe as tfe
class MyConvertedCode(cdktf.TerraformStack):
#
from imports.tfe.data_tfe_organization_membership import DataTfeOrganizationMembership
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
tfe.data_tfe_organization_membership.DataTfeOrganizationMembership(self, "test",
DataTfeOrganizationMembership(self, "test",
organization="my-org-name",
organization_membership_id="ou-xxxxxxxxxxx"
)
Expand All @@ -89,4 +98,4 @@ In addition to all arguments above, the following attributes are exported:
* `user_id` - The ID of the user associated with the organization membership.
* `username` - The username of the user associated with the organization membership.

<!-- cache-key: cdktf-0.17.0-pre.15 input-d0160d0a09a0b3ce6035db02657e5b320810e469cbd9da4ae71b7158b313258f -->
<!-- cache-key: cdktf-0.19.0 input-d0160d0a09a0b3ce6035db02657e5b320810e469cbd9da4ae71b7158b313258f -->
Loading

0 comments on commit 74c0a31

Please sign in to comment.