Merge pull request #35979 from hashicorp/d-cdktf-docs-8048243993-79

cdktf: update documentation
hashicorp · Feb 26, 2024 · 9eb9e1d · 9eb9e1d
2 parents 1ede054 + 7bfecb8
commit 9eb9e1d
Show file tree

Hide file tree

Showing 260 changed files with 8,793 additions and 1,108 deletions.
diff --git a/website/docs/cdktf/python/d/batch_job_definition.html.markdown b/website/docs/cdktf/python/d/batch_job_definition.html.markdown
diff --git a/website/docs/cdktf/python/d/bedrock_custom_model.html.markdown b/website/docs/cdktf/python/d/bedrock_custom_model.html.markdown
@@ -0,0 +1,64 @@
+---
+subcategory: "Amazon Bedrock"
+layout: "aws"
+page_title: "AWS: aws_bedrock_custom_model"
+description: |-
+  Returns properties of a specific Amazon Bedrock custom model.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_bedrock_custom_model
+
+Returns properties of a specific Amazon Bedrock custom model.
+
+## Example Usage
+
+```python
+# 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.
+#
+from imports.aws.data_aws_bedrock_custom_model import DataAwsBedrockCustomModel
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsBedrockCustomModel(self, "test",
+            model_id="arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 "
+        )
+```
+
+## Argument Reference
+
+* `model_id` – (Required) Name or ARN of the custom model.
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `base_model_arn` - ARN of the base model.
+* `creation_time` - Creation time of the model.
+* `hyperparameters` - Hyperparameter values associated with this model.
+* `job_arn` - Job ARN associated with this model.
+* `job_name` - Job name associated with this model.
+* `job_tags` - Key-value mapping of tags for the fine-tuning job.
+* `model_arn` - ARN associated with this model.
+* `model_kms_key_arn` - The custom model is encrypted at rest using this key.
+* `model_name` - Model name associated with this model.
+* `model_tags` - Key-value mapping of tags for the model.
+* `output_data_config` - Output data configuration associated with this custom model.
+    * `s3_uri` - The S3 URI where the output data is stored.
+* `training_data_config` - Information about the training dataset.
+    * `s3_uri` - The S3 URI where the training data is stored.
+* `training_metrics` - Metrics associated with the customization job.
+    * `training_loss` - Loss metric associated with the customization job.
+* `validation_data_config` - Information about the validation dataset.
+    * `validator` - Information about the validators.
+        * `s3_uri` - The S3 URI where the validation data is stored..
+* `validation_metrics` - The loss metric for each validator that you provided.
+    * `validation_loss` - The validation loss associated with the validator.
+
+<!-- cache-key: cdktf-0.20.1 input-9d7ebec3f75401eee70e98691f002ad65f0b09c6fcd48e93308bf9aa6010f5da -->
diff --git a/website/docs/cdktf/python/d/bedrock_custom_models.html.markdown b/website/docs/cdktf/python/d/bedrock_custom_models.html.markdown
@@ -0,0 +1,45 @@
+---
+subcategory: "Amazon Bedrock"
+layout: "aws"
+page_title: "AWS: aws_bedrock_custom_models"
+description: |-
+  Returns a list of Amazon Bedrock custom models.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_bedrock_custom_models
+
+Returns a list of Amazon Bedrock custom models.
+
+## Example Usage
+
+```python
+# 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.
+#
+from imports.aws.data_aws_bedrock_custom_models import DataAwsBedrockCustomModels
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsBedrockCustomModels(self, "test")
+```
+
+## Argument Reference
+
+None.
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `model_summaries` - Model summaries.
+    * `creation_time` - Creation time of the model.
+    * `model_arn` - The ARN of the custom model.
+    * `model_name` - The name of the custom model.
+
+<!-- cache-key: cdktf-0.20.1 input-5c8a3f3692382ecd35babad90f7ea55ce880124425b33d50e7c1631f449d3166 -->
diff --git a/website/docs/cdktf/python/d/cloudfront_origin_access_identity.html.markdown b/website/docs/cdktf/python/d/cloudfront_origin_access_identity.html.markdown
@@ -29,13 +29,13 @@ class MyConvertedCode(TerraformStack):
     def __init__(self, scope, name):
         super().__init__(scope, name)
         DataAwsCloudfrontOriginAccessIdentity(self, "example",
-            id="EDFDVBD632BHDS5"
+            id="E1ZAKK699EOLAL"
         )
 ```
 
 ## Argument Reference
 
-* `id` (Required) -  The identifier for the distribution. For example: `EDFDVBD632BHDS5`.
+* `id` (Required) -  The identifier for the origin access identity. For example: `E1ZAKK699EOLAL`.
 
 ## Attribute Reference
 
@@ -55,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a
    access identity, which you use when giving the origin access identity read
    permission to an object in Amazon S3.
 
-<!-- cache-key: cdktf-0.20.1 input-6ee07d67e88c83135a682bc01ecae9a6413d07992377fed93295e34cd1b0ceec -->
+<!-- cache-key: cdktf-0.20.1 input-a7cd9b1786140626f45007d44ca5d963414beca09e6e286c1818e2e771206508 -->
diff --git a/website/docs/cdktf/python/d/codecommit_repository.html.markdown b/website/docs/cdktf/python/d/codecommit_repository.html.markdown
@@ -41,9 +41,10 @@ This data source supports the following arguments:
 
 This data source exports the following attributes in addition to the arguments above:
 
-* `repository_id` - ID of the repository
-* `arn` - ARN of the repository
+* `repository_id` - ID of the repository.
+* `kms_key_id` - The ID of the encryption key.
+* `arn` - ARN of the repository.
 * `clone_url_http` - URL to use for cloning the repository over HTTPS.
 * `clone_url_ssh` - URL to use for cloning the repository over SSH.
 
-<!-- cache-key: cdktf-0.20.1 input-5f322aa9e58ade376d26a7bc7fcca823f5fc4c32d9a5916f862aea8c60b99b90 -->
+<!-- cache-key: cdktf-0.20.1 input-b16ab4c6988819daea4a817d385a8fcb8fc011d4cde702f73a6773161f2a029a -->
diff --git a/website/docs/cdktf/python/d/codestarconnections_connection.html.markdown b/website/docs/cdktf/python/d/codestarconnections_connection.html.markdown
@@ -69,7 +69,7 @@ This data source exports the following attributes in addition to the arguments a
 * `id` - CodeStar Connection ARN.
 * `host_arn` - ARN of the host associated with the connection.
 * `name` - Name of the CodeStar Connection. The name is unique in the calling AWS account.
-* `provider_type` - Name of the external provider where your third-party code repository is configured. Possible values are `Bitbucket` and `GitHub`. For connections to a GitHub Enterprise Server instance, you must create an [aws_codestarconnections_host](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codestarconnections_host) resource and use `host_arn` instead.
+* `provider_type` - Name of the external provider where your third-party code repository is configured. Possible values are `Bitbucket`, `GitHub` and `GitLab`. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an [aws_codestarconnections_host](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codestarconnections_host) resource and use `host_arn` instead.
 * `tags` - Map of key-value resource tags to associate with the resource.
 
-<!-- cache-key: cdktf-0.20.1 input-ab1b1d204990cc42834998f3ea8aaf072f9c3accf6d33f73782ae59f7304b4b6 -->
+<!-- cache-key: cdktf-0.20.1 input-6f28ecae2d8d7141f1be21ec05ccde9accf02c775d0fd7470654e31d939b8d40 -->
diff --git a/website/docs/cdktf/python/d/cognito_user_group.html.markdown b/website/docs/cdktf/python/d/cognito_user_group.html.markdown
@@ -0,0 +1,53 @@
+---
+subcategory: "Cognito IDP (Identity Provider)"
+layout: "aws"
+page_title: "AWS: aws_cognito_user_group"
+description: |-
+  Terraform data source for managing an AWS Cognito IDP (Identity Provider) User Group.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_cognito_user_group
+
+Terraform data source for managing an AWS Cognito IDP (Identity Provider) User Group.
+
+## Example Usage
+
+### Basic Usage
+
+```python
+# 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.
+#
+from imports.aws.data_aws_cognito_user_group import DataAwsCognitoUserGroup
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsCognitoUserGroup(self, "example",
+            name="example",
+            user_pool_id="us-west-2_aaaaaaaaa"
+        )
+```
+
+## Argument Reference
+
+The following arguments are required:
+
+* `name` - (Required) Name of the user group.
+* `user_pool_id` - (Required) User pool the client belongs to.
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `description` - Description of the user group.
+* `id` - A comma-delimited string concatenating `name` and `user_pool_id`.
+* `precedence` - Precedence of the user group.
+* `role_arn` - ARN of the IAM role to be associated with the user group.
+
+<!-- cache-key: cdktf-0.20.1 input-27df73fb237762edc7cf45b6bd3efdbad132db982d809d1c48656693e1ae599d -->
diff --git a/website/docs/cdktf/python/d/cognito_user_groups.html.markdown b/website/docs/cdktf/python/d/cognito_user_groups.html.markdown
@@ -0,0 +1,56 @@
+---
+subcategory: "Cognito IDP (Identity Provider)"
+layout: "aws"
+page_title: "AWS: aws_cognito_user_groups"
+description: |-
+  Terraform data source for managing AWS Cognito IDP (Identity Provider) User Groups.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_cognito_user_groups
+
+Terraform data source for managing AWS Cognito IDP (Identity Provider) User Groups.
+
+## Example Usage
+
+### Basic Usage
+
+```python
+# 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.
+#
+from imports.aws.data_aws_cognito_user_groups import DataAwsCognitoUserGroups
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsCognitoUserGroups(self, "example",
+            user_pool_id="us-west-2_aaaaaaaaa"
+        )
+```
+
+## Argument Reference
+
+The following arguments are required:
+
+* `user_pool_id` - (Required) User pool the client belongs to.
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `id` - User pool identifier.
+* `groups` - List of groups. See [`groups`](#groups) below.
+
+### groups
+
+* `description` - Description of the user group.
+* `group_name` - Name of the user group.
+* `precedence` - Precedence of the user group.
+* `role_arn` - ARN of the IAM role to be associated with the user group.
+
+<!-- cache-key: cdktf-0.20.1 input-b9ec4c71ef4f31f9a750655ce24ceb46439e2d99ccaf3e06f390319d638dd1c3 -->
diff --git a/website/docs/cdktf/python/d/db_parameter_group.markdown b/website/docs/cdktf/python/d/db_parameter_group.markdown
@@ -0,0 +1,48 @@
+---
+subcategory: "RDS (Relational Database)"
+layout: "aws"
+page_title: "AWS: aws_db_parameter_group"
+description: |-
+  Information about a database parameter group.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_db_parameter_group
+
+Information about a database parameter group.
+
+## Example Usage
+
+```python
+# 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.
+#
+from imports.aws.data_aws_db_parameter_group import DataAwsDbParameterGroup
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsDbParameterGroup(self, "test",
+            name="default.postgres15"
+        )
+```
+
+## Argument Reference
+
+The following arguments are required:
+
+* `name` - (Required) DB parameter group name.
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `arn` - ARN of the parameter group.
+* `family` - Family of the parameter group.
+* `description` - Description of the parameter group.
+
+<!-- cache-key: cdktf-0.20.1 input-2e8c83eaf1d663390db1bfa0c327919fdf188145cf8fee65580921c784fe6bdb -->
diff --git a/website/docs/cdktf/python/d/ec2_instance_type.html.markdown b/website/docs/cdktf/python/d/ec2_instance_type.html.markdown
@@ -89,6 +89,7 @@ This data source exports the following attributes in addition to the arguments a
 * `ipv6_supported` - `true` if IPv6 is supported.
 * `maximum_ipv4_addresses_per_interface` - The maximum number of IPv4 addresses per network interface.
 * `maximum_ipv6_addresses_per_interface` - The maximum number of IPv6 addresses per network interface.
+* `maximum_network_cards` - The maximum number of physical network cards that can be allocated to the instance.
 * `maximum_network_interfaces` - The maximum number of network interfaces for the instance type.
 * `memory_size` - Size of the instance memory, in MiB.
 * `network_performance` - Describes the network performance.
@@ -110,4 +111,4 @@ This data source exports the following attributes in addition to the arguments a
 
 - `read` - (Default `20m`)
 
-<!-- cache-key: cdktf-0.20.1 input-b7277db3a541ce0f8fed6f01d3571ab61e9905732dcb0c8ed05bebf2a1116184 -->
+<!-- cache-key: cdktf-0.20.1 input-252aea618bdc0d84a31b332d0bcbeb1cfa651313c051ec4ccf79e7e89e9f6ce2 -->
diff --git a/website/docs/cdktf/python/d/ecr_pull_through_cache_rule.html.markdown b/website/docs/cdktf/python/d/ecr_pull_through_cache_rule.html.markdown
@@ -42,7 +42,8 @@ This data source supports the following arguments:
 This data source exports the following attributes in addition to the arguments above:
 
 - `id` - The repository name prefix.
-- `upstream_registry_url` - The registry URL of the upstream public registry to use as the source.
+- `credential_arn` - ARN of the Secret which will be used to authenticate against the registry.
 - `registry_id` - The registry ID where the repository was created.
+- `upstream_registry_url` - The registry URL of the upstream public registry to use as the source.
 
-<!-- cache-key: cdktf-0.20.1 input-3ee2ad3b6b1782465fd57fc7a664c3cb24f3d2959a61a327dc70b472c5eb08e8 -->
+<!-- cache-key: cdktf-0.20.1 input-51f9ce17c5f6437a6a7033bcc7164586c2d49132414e45c72255adc80ed3befc -->
diff --git a/website/docs/cdktf/python/d/ecs_task_execution.html.markdown b/website/docs/cdktf/python/d/ecs_task_execution.html.markdown
@@ -53,6 +53,7 @@ The following arguments are required:
 The following arguments are optional:
 
 * `capacity_provider_strategy` - (Optional) Set of capacity provider strategies to use for the cluster. See below.
+* `client_token` - (Optional) An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html).
 * `desired_count` - (Optional) Number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
 * `enable_ecs_managed_tags` - (Optional) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
 * `enable_execute_command` - (Optional) Specifies whether to enable Amazon ECS Exec for the tasks within the service.
@@ -135,4 +136,4 @@ This data source exports the following attributes in addition to the arguments a
 * `task_arns` - A list of the provisioned task ARNs.
 * `id` - The unique identifier, which is a comma-delimited string joining the `cluster` and `task_definition` attributes.
 
-<!-- cache-key: cdktf-0.20.1 input-43e278c1402adce6a7fc73f884efc857a1ca139e84ad68f7ea78a5f8b607b74c -->
+<!-- cache-key: cdktf-0.20.1 input-e4a4f9cc9f61093c0b25b3b6303b804642909347d59647c613ab6248c6e8f762 -->