Skip to content

Commit

Permalink
Merge pull request #33069 from hashicorp/d-cdktf-docs-5892773880-27
Browse files Browse the repository at this point in the history 
cdktf: update documentation
  • Loading branch information
@ewbankkit
ewbankkit committed Aug 17, 2023
2 parents 7f7c17a + dad54fe commit 290acf3
Show file tree
Hide file tree
Showing 3,519 changed files with 36,718 additions and 12,442 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
9 changes: 7 additions & 2 deletions .github/workflows/website.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,12 @@ jobs:
use-verbose-mode: "yes"
config-file: ".ci/.markdownlinkcheck.json"
folder-path: "website/docs"
# Don't check CDKTF translated guides, e.g. website/docs/cdktf/typescript/guides/version-4-upgrade.html.md.
max-depth: 2
file-extension: ".md"
base-branch: "main"
check-modified-files-only: "yes"
# Checking only modified files in the PR does not respect 'mex-depth'.
# base-branch: "main"
# check-modified-files-only: "yes"

markdown-lint:
runs-on: ubuntu-latest
Expand All @@ -71,6 +74,8 @@ jobs:
- uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0
with:
args: "website/docs"
# Ignore CDKTF translated guides.
ignore: "website/docs/cdktf/*/guides/*"

misspell:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/acm_certificate.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ it by domain without having to hard code the ARNs as input.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -64,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a
* `certificate_chain` - Certificates forming the requested ACM-issued certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.
* `tags` - Mapping of tags for the resource.

<!-- cache-key: cdktf-0.17.1 input-0827f19734f2b9d26e0cb7f069a9c6094d49e933890f68cd0c6364c65af42e86 -->
<!-- cache-key: cdktf-0.18.0 input-0827f19734f2b9d26e0cb7f069a9c6094d49e933890f68cd0c6364c65af42e86 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/acmpca_certificate.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Get information on a Certificate issued by a AWS Certificate Manager Private Cer
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a
* `certificate` - PEM-encoded certificate value.
* `certificate_chain` - PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA.

<!-- cache-key: cdktf-0.17.1 input-f7804d061124fc6489bcc7d11d155c5a561ad1fe6aac3da7e0bdce8a5bdbf606 -->
<!-- cache-key: cdktf-0.18.0 input-f7804d061124fc6489bcc7d11d155c5a561ad1fe6aac3da7e0bdce8a5bdbf606 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/acmpca_certificate_authority.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Get information on a AWS Certificate Manager Private Certificate Authority (ACM
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -62,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a
* `tags` - Key-value map of user-defined tags that are attached to the certificate authority.
* `type` - Type of the certificate authority.

<!-- cache-key: cdktf-0.17.1 input-bc455641e95958e404dd0619abf86e9d1dc1b0604b9b489c29ed39db56a62037 -->
<!-- cache-key: cdktf-0.18.0 input-bc455641e95958e404dd0619abf86e9d1dc1b0604b9b489c29ed39db56a62037 -->
2 changes: 1 addition & 1 deletion website/docs/cdktf/python/d/ami.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ interpolation.

[1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html

<!-- cache-key: cdktf-0.17.1 input-b27379b47e46b092af0eb0d0592f4690caa729d66535c1d3f2706e8aa24bff38 -->
<!-- cache-key: cdktf-0.18.0 input-b27379b47e46b092af0eb0d0592f4690caa729d66535c1d3f2706e8aa24bff38 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/ami_ids.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get a list of AMI IDs matching the specified criteria.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -71,4 +71,4 @@ If false, no deprecated AMIs are included in the response. If no value is specif

- `read` - (Default `20m`)

<!-- cache-key: cdktf-0.17.1 input-df8435503c645904f83640627b35c5031003b38da5f178afcb6e456e7076b481 -->
<!-- cache-key: cdktf-0.18.0 input-df8435503c645904f83640627b35c5031003b38da5f178afcb6e456e7076b481 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_api_key.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ example to supply credentials for a dependency microservice.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -49,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a
* `enabled` - Whether the API Key is enabled.
* `tags` - Map of tags for the resource.

<!-- cache-key: cdktf-0.17.1 input-17297a64af50979746acd59feb4bc637e441edcf9aac1743e07b3d713dd934c5 -->
<!-- cache-key: cdktf-0.18.0 input-17297a64af50979746acd59feb4bc637e441edcf9aac1743e07b3d713dd934c5 -->
8 changes: 4 additions & 4 deletions website/docs/cdktf/python/d/api_gateway_authorizer.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Provides details about a specific API Gateway Authorizer.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import property_access, Token, TerraformStack
from cdktf import Fn, Token, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
Expand All @@ -28,7 +28,7 @@ class MyConvertedCode(TerraformStack):
super().__init__(scope, name)
DataAwsApiGatewayAuthorizer(self, "example",
authorizer_id=Token.as_string(
property_access(data_aws_api_gateway_authorizers_example.ids, ["0"])),
Fn.lookup_nested(data_aws_api_gateway_authorizers_example.ids, ["0"])),
rest_api_id=Token.as_string(aws_api_gateway_rest_api_example.id)
)
```
Expand All @@ -54,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a
* `provider_arns` - List of the Amazon Cognito user pool ARNs.
* `type` - Type of the authorizer.

<!-- cache-key: cdktf-0.17.1 input-7c505056a62ecddc8f4337cf059da361268167b1838c9f6ea4a6d78a7e84dfe3 -->
<!-- cache-key: cdktf-0.18.0 input-7c505056a62ecddc8f4337cf059da361268167b1838c9f6ea4a6d78a7e84dfe3 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_authorizers.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Provides details about multiple API Gateway Authorizers.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformStack
#
Expand Down Expand Up @@ -43,4 +43,4 @@ This data source exports the following attributes in addition to the arguments a

* `ids` - List of Authorizer identifiers.

<!-- cache-key: cdktf-0.17.1 input-c3a17d70af9b0ac8d5e391a543335f1243e9dec902c7497cf1df2083482e833c -->
<!-- cache-key: cdktf-0.18.0 input-c3a17d70af9b0ac8d5e391a543335f1243e9dec902c7497cf1df2083482e833c -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_domain_name.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this data source to get the custom domain name for use with AWS API Gateway.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -54,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a
* `security_policy` - Security policy for the domain name.
* `tags` - Key-value map of tags for the resource.

<!-- cache-key: cdktf-0.17.1 input-ec3ad0e8dda61e42fd75917952379778e983a6bf94a2c3f251ea482b57cbc3ed -->
<!-- cache-key: cdktf-0.18.0 input-ec3ad0e8dda61e42fd75917952379778e983a6bf94a2c3f251ea482b57cbc3ed -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_export.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformStack
#
Expand Down Expand Up @@ -48,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a
* `content_type` - Content-type header value in the HTTP response.
* `content_disposition` - Content-disposition header value in the HTTP response.

<!-- cache-key: cdktf-0.17.1 input-c510075eea42189371d3ef965a6842b44146a7635515b8e6bc3e2af00098b481 -->
<!-- cache-key: cdktf-0.18.0 input-c510075eea42189371d3ef965a6842b44146a7635515b8e6bc3e2af00098b481 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_resource.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To fetch the Resource, you must provide the REST API id as well as the full path
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformStack
#
Expand Down Expand Up @@ -50,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a
* `parent_id` - Set to the ID of the parent Resource.
* `path_part` - Set to the path relative to the parent Resource.

<!-- cache-key: cdktf-0.17.1 input-de42d4fd9ee5838ea57bf49335869fd7bec10ba3cea3b7e525af92359ab7bd14 -->
<!-- cache-key: cdktf-0.18.0 input-de42d4fd9ee5838ea57bf49335869fd7bec10ba3cea3b7e525af92359ab7bd14 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_rest_api.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ error if there is more than one match.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -54,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a
* `root_resource_id` - Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.
* `tags` - Key-value map of resource tags.

<!-- cache-key: cdktf-0.17.1 input-f58dd0e8318def3e704471e581c407920560534f1c0b60ba367ee144e50a3888 -->
<!-- cache-key: cdktf-0.18.0 input-f58dd0e8318def3e704471e581c407920560534f1c0b60ba367ee144e50a3888 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_sdk.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: |-
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformStack
#
Expand Down Expand Up @@ -53,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a
* `content_type` - Content-type header value in the HTTP response.
* `content_disposition` - Content-disposition header value in the HTTP response.

<!-- cache-key: cdktf-0.17.1 input-ed1f26956d947879c351283b69f137259d03aa3d3365cfd1ed2dbc55a4d3774e -->
<!-- cache-key: cdktf-0.18.0 input-ed1f26956d947879c351283b69f137259d03aa3d3365cfd1ed2dbc55a4d3774e -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/api_gateway_vpc_link.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ error if there is more than one match.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -50,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a
* `target_arns` - List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
* `tags` - Key-value map of resource tags

<!-- cache-key: cdktf-0.17.1 input-b5278dc46deda6987341a0eea118c91f7f9e8d4ab7dbcf2deaf2fce3bb8b0ca2 -->
<!-- cache-key: cdktf-0.18.0 input-b5278dc46deda6987341a0eea118c91f7f9e8d4ab7dbcf2deaf2fce3bb8b0ca2 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/apigatewayv2_api.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Provides details about a specific Amazon API Gateway Version 2 API.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -70,4 +70,4 @@ The `cors_configuration` object supports the following:
* `expose_headers` - Set of exposed HTTP headers.
* `max_age` - Number of seconds that the browser should cache preflight request results.

<!-- cache-key: cdktf-0.17.1 input-476586bb733fc0bcc5e9d7e9c2f79656a99a92d47ca1c6953fdfd3eeeab546d6 -->
<!-- cache-key: cdktf-0.18.0 input-476586bb733fc0bcc5e9d7e9c2f79656a99a92d47ca1c6953fdfd3eeeab546d6 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/apigatewayv2_apis.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Provides details about multiple Amazon API Gateway Version 2 APIs.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a

* `ids` - Set of API identifiers.

<!-- cache-key: cdktf-0.17.1 input-a7653185a80a5e9399fb3e9d08f770ad4a08a7d1b822a172fdc6e2674fc1dd03 -->
<!-- cache-key: cdktf-0.18.0 input-a7653185a80a5e9399fb3e9d08f770ad4a08a7d1b822a172fdc6e2674fc1dd03 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/apigatewayv2_export.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Exports a definition of an API in a particular output format and specification.
## Example Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformStack
#
Expand Down Expand Up @@ -51,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a
* `id` - API identifier.
* `body` - ID of the API.

<!-- cache-key: cdktf-0.17.1 input-6480a64e749693f83cf73592ca35d58ca5a49b6e975099c338b5341415898a74 -->
<!-- cache-key: cdktf-0.18.0 input-6480a64e749693f83cf73592ca35d58ca5a49b6e975099c338b5341415898a74 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/appconfig_configuration_profile.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Provides access to an AppConfig Configuration Profile.
### Basic Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -56,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a
* `content` - Either the JSON Schema content or the ARN of an AWS Lambda function.
* `type` - Type of validator. Valid values: JSON_SCHEMA and LAMBDA.

<!-- cache-key: cdktf-0.17.1 input-812d16f674999964ab6b67e20ad1395ac161f98caaa88682a62205246057f321 -->
<!-- cache-key: cdktf-0.18.0 input-812d16f674999964ab6b67e20ad1395ac161f98caaa88682a62205246057f321 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/appconfig_configuration_profiles.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Profile IDs to another resource.
### Basic Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformIterator, TerraformStack
#
Expand Down Expand Up @@ -61,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a

* `configuration_profile_ids` - Set of Configuration Profile IDs associated with the AppConfig Application.

<!-- cache-key: cdktf-0.17.1 input-b4fc2e385f4cf8f2b77339adbebe9e03369792e3c761bb5599667ff5bad6268d -->
<!-- cache-key: cdktf-0.18.0 input-b4fc2e385f4cf8f2b77339adbebe9e03369792e3c761bb5599667ff5bad6268d -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/appconfig_environment.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Provides access to an AppConfig Environment.
### Basic Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -55,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a
or `ROLLED_BACK`.
* `tags` - Map of tags for the resource.

<!-- cache-key: cdktf-0.17.1 input-2536eae28938ccf1a8bf0a1e33718611d0fbfe4294f71a133d77dbe21bc83180 -->
<!-- cache-key: cdktf-0.18.0 input-2536eae28938ccf1a8bf0a1e33718611d0fbfe4294f71a133d77dbe21bc83180 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/appconfig_environments.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ resource.
### Basic Usage

```python
# Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
Expand Down Expand Up @@ -46,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a

* `environment_ids` - Set of Environment IDs associated with this AppConfig Application.

<!-- cache-key: cdktf-0.17.1 input-b2458ae100264c5acfd0fedda3d10f3ece761d168943b6b933cee8edcda8140a -->
<!-- cache-key: cdktf-0.18.0 input-b2458ae100264c5acfd0fedda3d10f3ece761d168943b6b933cee8edcda8140a -->

0 comments on commit 290acf3

Please sign in to comment.