Merge pull request #41756 from hashicorp/d-cdktf-docs-13753951574-139

cdktf: update documentation
hashicorp · Mar 10, 2025 · 93dadb6 · 93dadb6
2 parents f53f671 + 4cf4a4b
commit 93dadb6
Show file tree

Hide file tree

Showing 184 changed files with 1,576 additions and 870 deletions.
diff --git a/website/docs/cdktf/python/d/cloudfront_cache_policy.html.markdown b/website/docs/cdktf/python/d/cloudfront_cache_policy.html.markdown
@@ -68,6 +68,7 @@ This data source supports the following arguments:
 
 This data source exports the following attributes in addition to the arguments above:
 
+* `arn` - The cache policy ARN.
 * `etag` - Current version of the cache policy.
 * `min_ttl` - Minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated.
 * `max_ttl` - Maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated.
@@ -102,4 +103,4 @@ This data source exports the following attributes in addition to the arguments a
 
 * `items` - List of item names (`cookies`, `headers`, or `query_strings`).
 
-<!-- cache-key: cdktf-0.20.8 input-ab7307a97a5d45b87ff7a2f2e57ecbc160c935a3157cc754400d20fed1fd75e9 -->
+<!-- cache-key: cdktf-0.20.8 input-ae64319741853a619a0c5d8c2510bbaa4bfba2a2bf19e3e1e03e7be0b32c653c -->
diff --git a/website/docs/cdktf/python/d/cloudfront_origin_access_control.html.markdown b/website/docs/cdktf/python/d/cloudfront_origin_access_control.html.markdown
@@ -41,11 +41,12 @@ class MyConvertedCode(TerraformStack):
 
 This data source exports the following attributes in addition to the arguments above:
 
+* `arn` - The origin access control ARN.
 * `description` - A description of the origin access control.
 * `etag` - Current version of the origin access control's information. For example: `E2QWRUHAPOMQZL`.
 * `name` - A name to identify the origin access control.
 * `origin_access_control_origin_type` - The type of origin that this origin access control is for.
 * `signing_behavior` - Specifies which requests CloudFront signs.
 * `signing_protocol` - The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.
 
-<!-- cache-key: cdktf-0.20.8 input-d5d6bf9fddc15f4e3279f7cb24d7a6a24a6521b6ab3281bd8fa47bc5b7bade5f -->
+<!-- cache-key: cdktf-0.20.8 input-ef4cd6cd4f6def17dafefee526d15ff5890f454c03734fc370573bb379f89bf2 -->
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
@@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack):
 
 This data source exports the following attributes in addition to the arguments above:
 
+* `arn` - The origin access identity ARN.
 * `caller_reference` - Internal value used by CloudFront to allow future
    updates to the origin access identity.
 * `cloudfront_access_identity_path` - A shortcut to the full path for the
@@ -55,4 +56,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.8 input-a7cd9b1786140626f45007d44ca5d963414beca09e6e286c1818e2e771206508 -->
+<!-- cache-key: cdktf-0.20.8 input-d6aa01a36ddcd8aafd4a0701f1d664d82a0f23828a5b6b35aa4e9d44cc3124f6 -->
diff --git a/website/docs/cdktf/python/d/cloudfront_origin_request_policy.html.markdown b/website/docs/cdktf/python/d/cloudfront_origin_request_policy.html.markdown
@@ -63,6 +63,7 @@ This data source supports the following arguments:
 
 This data source exports the following attributes in addition to the arguments above:
 
+* `arn` - The origin request policy ARN.
 * `comment` - Comment to describe the origin request policy.
 * `cookies_config` - Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the origin request key and automatically included in requests that CloudFront sends to the origin. See [Cookies Config](#cookies-config) for more information.
 * `etag` - Current version of the origin request policy.
@@ -88,4 +89,4 @@ This data source exports the following attributes in addition to the arguments a
 
 `items` - List of item names (cookies, headers, or query strings).
 
-<!-- cache-key: cdktf-0.20.8 input-302109f4c0fde1e60aeb00b2aa87f0426e0944c3dc7969f58b1b182e3ccb56a1 -->
+<!-- cache-key: cdktf-0.20.8 input-6634b7fe26a9d88b0252cc369837a358f24b0b60ff2309b6cc17a5f9664a1ec4 -->
diff --git a/website/docs/cdktf/python/d/cloudfront_response_headers_policy.html.markdown b/website/docs/cdktf/python/d/cloudfront_response_headers_policy.html.markdown
@@ -65,6 +65,7 @@ This data source supports the following arguments:
 
 This data source exports the following attributes in addition to the arguments above:
 
+* `arn` - The response headers policy ARN.
 * `comment` - Comment to describe the response headers policy. The comment cannot be longer than 128 characters.
 * `etag` - Current version of the response headers policy.
 * `cors_config` - Configuration for a set of HTTP response headers that are used for Cross-Origin Resource Sharing (CORS). See [Cors Config](#cors-config) for more information.
@@ -139,4 +140,4 @@ This data source exports the following attributes in addition to the arguments a
 * `enabled` - Whether CloudFront adds the `Server-Timing` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
 * `sampling_rate` - Number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to.
 
-<!-- cache-key: cdktf-0.20.8 input-72a56289982ff99c5a8915f5f70bc400c310b4c8325a6846d6c8b892d3eab9cb -->
+<!-- cache-key: cdktf-0.20.8 input-7f7a22e4a13361be23802f57b5a88ccd777739eb6e93d69ff4bff2f9ca2f4d3c -->
diff --git a/website/docs/cdktf/python/d/datazone_domain.html.markdown b/website/docs/cdktf/python/d/datazone_domain.html.markdown
@@ -0,0 +1,56 @@
+---
+subcategory: "DataZone"
+layout: "aws"
+page_title: "AWS: aws_datazone_domain"
+description: |-
+  Terraform data source for managing an AWS DataZone Domain.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_datazone_domain
+
+Terraform data source for managing an AWS DataZone Domain.
+
+## 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. import DataAwsDatazoneDomain
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsDatazoneDomain(self, "example",
+            name="example_domain"
+        )
+```
+
+## Argument Reference
+
+The following arguments are required:
+
+* `name` - (Optional) Name of the Domain. One of `name` or `id` is required.
+* `id` - (Optional) ID of the Domain. One of `name` or `id` is required
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `arn` - ARN of the Domain.
+* `created_at` - The date and time the Domain was created.
+* `description` - Description of the Domain.
+* `domain_version` - Version of the Domain.
+* `last_updated_at` - The date and time the Domain was last updated.
+* `managed_account_id` - The AWS account ID that owns the Domain.
+* `portal_url` - URL of the Domain.
+* `status` - Status of the Domain.
+
+<!-- cache-key: cdktf-0.20.8 input-9d9395e4f439811a9509b29c64afddda4fdc23cd2116ad85bdf7b362242359a0 -->
diff --git a/website/docs/cdktf/python/d/dx_connection.html.markdown b/website/docs/cdktf/python/d/dx_connection.html.markdown
@@ -47,7 +47,8 @@ This data source exports the following attributes in addition to the arguments a
 * `owner_account_id` - ID of the AWS account that owns the connection.
 * `partner_name` - The name of the AWS Direct Connect service provider associated with the connection.
 * `provider_name` - Name of the service provider associated with the connection.
+* `state` - State of the connection.
 * `tags` - Map of tags for the resource.
 * `vlan_id` - The VLAN ID.
 
-<!-- cache-key: cdktf-0.20.8 input-192e94cc169312d4fa902eb3bcc5d1de027e5be4fe92fdaf9fdbeefc124a32a8 -->
+<!-- cache-key: cdktf-0.20.8 input-ee7442e2c312c4de1313a67206127c5d5a68b5ee77b2867d9bd5f4579bfd851e -->
diff --git a/website/docs/cdktf/python/d/ecs_task_execution.html.markdown b/website/docs/cdktf/python/d/ecs_task_execution.html.markdown
@@ -88,7 +88,7 @@ For more information, see the [Task Networking](https://docs.aws.amazon.com/Amaz
 * `container_overrides` - (Optional) One or more container overrides that are sent to a task. See below.
 * `cpu` - (Optional) The CPU override for the task.
 * `execution_role_arn` - (Optional) Amazon Resource Name (ARN) of the task execution role override for the task.
-* `inference_accelerator_overrides` - (Optional) Elastic Inference accelerator override for the task. See below.
+* `inference_accelerator_overrides` - (Optional) **DEPRECATED** Elastic Inference accelerator override for the task. See below.
 * `memory` - (Optional) The memory override for the task.
 * `task_role_arn` - (Optional) Amazon Resource Name (ARN) of the role that containers in this task can assume.
 
@@ -136,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.8 input-e4a4f9cc9f61093c0b25b3b6303b804642909347d59647c613ab6248c6e8f762 -->
+<!-- cache-key: cdktf-0.20.8 input-04eaaebcee71de70c7c4b510fb4c21b0b4155ad960e6259f6625e1b29064a03c -->
diff --git a/website/docs/cdktf/python/d/opensearch_domain.html.markdown b/website/docs/cdktf/python/d/opensearch_domain.html.markdown
@@ -66,12 +66,18 @@ This data source exports the following attributes in addition to the arguments a
     * `dedicated_master_type` - Instance type of the dedicated master nodes in the cluster.
     * `dedicated_master_count` - Number of dedicated master nodes in the cluster.
     * `multi_az_with_standby_enabled` - Whether a multi-AZ domain is turned on with a standby AZ.
-    * `zone_awareness_enabled` - Indicates whether zone awareness is enabled.
-    * `zone_awareness_config` - Configuration block containing zone awareness settings.
-        * `availability_zone_count` - Number of availability zones used.
+    * `node_options` - List of node options for the domain.
+        * `node_config` - Sizing of a node type.
+            * `count` - Number of nodes of a particular node type in the cluster.
+            * `enabled` - Whether a particular node type is enabled.
+            * `type` - The instance type of a particular node type in the cluster.
+        * `node_type` - Type of node this configuration describes.
     * `warm_enabled` - Warm storage is enabled.
     * `warm_count` - Number of warm nodes in the cluster.
     * `warm_type` - Instance type for the OpenSearch cluster's warm nodes.
+    * `zone_awareness_enabled` - Indicates whether zone awareness is enabled.
+    * `zone_awareness_config` - Configuration block containing zone awareness settings.
+        * `availability_zone_count` - Number of availability zones used.
 * `cognito_options` - Domain Amazon Cognito Authentication options for Dashboard.
     * `enabled` - Whether Amazon Cognito Authentication is enabled.
     * `user_pool_id` - Cognito User pool used by the domain.
@@ -121,4 +127,4 @@ This data source exports the following attributes in addition to the arguments a
     * `subnet_ids` - Subnets used by the domain.
     * `vpc_id` - VPC used by the domain.
 
-<!-- cache-key: cdktf-0.20.8 input-206305f479449066996709d5dfec811f0b8097d8aa6496cf6fc11d73f4ca4b5b -->
+<!-- cache-key: cdktf-0.20.8 input-837de436745fda2e63a3c16e01709893584fc4561159fc72f98d83229cc7d58b -->
diff --git a/website/docs/cdktf/python/d/sagemaker_prebuilt_ecr_image.html.markdown b/website/docs/cdktf/python/d/sagemaker_prebuilt_ecr_image.html.markdown
@@ -3,14 +3,14 @@ subcategory: "SageMaker AI"
 layout: "aws"
 page_title: "AWS: aws_sagemaker_prebuilt_ecr_image"
 description: |-
-  Get information about prebuilt Amazon SageMaker Docker images.
+  Get information about prebuilt Amazon SageMaker AI  Docker images.
 ---
 
 
 <!-- Please do not edit this file, it is generated. -->
 # Data Source: aws_sagemaker_prebuilt_ecr_image
 
-Get information about prebuilt Amazon SageMaker Docker images.
+Get information about prebuilt Amazon SageMaker AI  Docker images.
 
 ~> **NOTE:** The AWS provider creates a validly constructed `registry_path` but does not verify that the `registry_path` corresponds to an existing image. For example, using a `registry_path` containing an `image_tag` that does not correspond to a Docker image in the ECR repository, will result in an error.
 
@@ -52,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a
 * `registry_id` - Account ID containing the image. For example, `469771592824`.
 * `registry_path` - Docker image URL. For example, `341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4`.
 
-<!-- cache-key: cdktf-0.20.8 input-a3201e5e9a1b42556fc373f74b47042558dd40fc2f7e45a814e9cbf2eff904fa -->
+<!-- cache-key: cdktf-0.20.8 input-8a59dc0a8fd4bf70b22036904137d87776ad39703d4873d5b17070f815bd2a96 -->
diff --git a/website/docs/cdktf/python/d/secretsmanager_secret_versions.html.markdown b/website/docs/cdktf/python/d/secretsmanager_secret_versions.html.markdown
@@ -88,9 +88,9 @@ This data source exports the following attributes in addition to the arguments a
 
 ### versions
 
-* `created_date` - Date and time this version of the secret was created.
+* `created_time` - Date and time this version of the secret was created.
 * `last_accessed_date` - Date that this version of the secret was last accessed.
 * `version_id` - Unique version identifier of this version of the secret.
-* `version_stage` - Staging label attached to the version.
+* `version_stages` - List of staging labels attached to the version.
 
-<!-- cache-key: cdktf-0.20.8 input-596ee491979af3a0973c463d5c307cdbedc26652f3a013026f6591e3a4084f60 -->
+<!-- cache-key: cdktf-0.20.8 input-2bb8af18ad6498bf9721e1fb842f8dd0446a3e68a97092f4f16b02f49d560e63 -->
diff --git a/website/docs/cdktf/python/d/sqs_queue.html.markdown b/website/docs/cdktf/python/d/sqs_queue.html.markdown
@@ -14,6 +14,8 @@ Use this data source to get the ARN and URL of queue in AWS Simple Queue Service
 By using this data source, you can reference SQS queues without having to hardcode
 the ARNs as input.
 
+~> **NOTE:** To use this data source, you must have the `sqs:GetQueueAttributes` and `sqs:GetQueueURL` permissions.
+
 ## Example Usage
 
 ```python
@@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a
 * `url` - URL of the queue.
 * `tags` - Map of tags for the resource.
 
-<!-- cache-key: cdktf-0.20.8 input-bc2387998bbb916bdcaa1a3f2f812935f5cc67ab5bb81f0bdfe43f5e898107d4 -->
+<!-- cache-key: cdktf-0.20.8 input-ad251ed3bcc7c77a93f2281dcdea74a3baac18c00c7ed39d9216027958d5e43c -->
diff --git a/website/docs/cdktf/python/d/vpc_endpoint.html.markdown b/website/docs/cdktf/python/d/vpc_endpoint.html.markdown
@@ -45,7 +45,7 @@ The given filters must match exactly one VPC endpoint whose data will be exporte
 
 * `filter` - (Optional) Custom filter block as described below.
 * `id` - (Optional) ID of the specific VPC Endpoint to retrieve.
-* `service_name` - (Optional) Service name of the specific VPC Endpoint to retrieve. For AWS services the service name is usually in the form `com.amazonaws.<region>.<service>` (the SageMaker Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker.<region>.notebook`).
+* `service_name` - (Optional) Service name of the specific VPC Endpoint to retrieve. For AWS services the service name is usually in the form `com.amazonaws.<region>.<service>` (the SageMaker AI Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker.<region>.notebook`).
 * `state` - (Optional) State of the specific VPC Endpoint to retrieve.
 * `tags` - (Optional) Map of tags, each pair of which must exactly match
   a pair on the specific VPC Endpoint to retrieve.
@@ -99,4 +99,4 @@ DNS options (for `dns_options`) support the following attributes:
 
 - `read` - (Default `20m`)
 
-<!-- cache-key: cdktf-0.20.8 input-4f0e8fcaf3803ffa7c58af668a56247f7f26ea4640aea7c4154cfad227c76bf4 -->
+<!-- cache-key: cdktf-0.20.8 input-98e29977e2149b3dfef0df54a69ee6043ad07505b5918db102c1f781bff48695 -->
diff --git a/website/docs/cdktf/python/d/vpc_endpoint_service.html.markdown b/website/docs/cdktf/python/d/vpc_endpoint_service.html.markdown
@@ -93,7 +93,7 @@ The given filters must match exactly one VPC endpoint service whose data will be
 
 * `filter` - (Optional) Configuration block(s) for filtering. Detailed below.
 * `service` - (Optional) Common name of an AWS service (e.g., `s3`).
-* `service_name` - (Optional) Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form `com.amazonaws.<region>.<service>` (the SageMaker Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker.<region>.notebook`).
+* `service_name` - (Optional) Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form `com.amazonaws.<region>.<service>` (the SageMaker AI Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker.<region>.notebook`).
 * `service_regions` - (Optional) AWS regions in which to look for services.
 * `service_type` - (Optional) Service type, `Gateway` or `Interface`.
 * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.
@@ -131,4 +131,4 @@ This data source exports the following attributes in addition to the arguments a
 
 - `read` - (Default `20m`)
 
-<!-- cache-key: cdktf-0.20.8 input-38d7121cfc7cba878f7c79020dee432097522a776d67ec066df32796d636d45a -->
+<!-- cache-key: cdktf-0.20.8 input-cab12df260f773a8c2d1885e24368dc15d34f3e5c3a8483cfb1a5e37cc12aeab -->
diff --git a/website/docs/cdktf/python/d/vpclattice_service.html.markdown b/website/docs/cdktf/python/d/vpclattice_service.html.markdown
@@ -49,9 +49,11 @@ This data source exports the following attributes in addition to the arguments a
 * `auth_type` - Type of IAM policy. Either `NONE` or `AWS_IAM`.
 * `certificate_arn` - Amazon Resource Name (ARN) of the certificate.
 * `custom_domain_name` - Custom domain name of the service.
-* `dns_entry` - DNS name of the service.
+* `dns_entry` - List of objects with DNS names.
+    * `domain_name` - DNS name for the service.
+    * `hosted_zone_id` - Hosted zone ID where the DNS name is registered.
 * `id` - Unique identifier for the service.
 * `status` - Status of the service.
 * `tags` - List of tags associated with the service.
 
-<!-- cache-key: cdktf-0.20.8 input-7b6870621548d47b2268852ea64bf86123c019e6fafbc3bb70238634ddfbd625 -->
+<!-- cache-key: cdktf-0.20.8 input-68e1bd88b311a92f192e4d7d4dd976040fc3dfc123cef0756b78975644405561 -->
diff --git a/website/docs/cdktf/python/guides/custom-service-endpoints.html.markdown b/website/docs/cdktf/python/guides/custom-service-endpoints.html.markdown
@@ -312,7 +312,7 @@ class MyConvertedCode(TerraformStack):
 |S3 Control|`s3control`|`AWS_ENDPOINT_URL_S3_CONTROL`|`s3_control`|
 |S3 on Outposts|`s3outposts`|`AWS_ENDPOINT_URL_S3OUTPOSTS`|`s3outposts`|
 |S3 Tables|`s3tables`|`AWS_ENDPOINT_URL_S3TABLES`|`s3tables`|
-|SageMaker|`sagemaker`|`AWS_ENDPOINT_URL_SAGEMAKER`|`sagemaker`|
+|SageMaker AI|`sagemaker`|`AWS_ENDPOINT_URL_SAGEMAKER`|`sagemaker`|
 |EventBridge Scheduler|`scheduler`|`AWS_ENDPOINT_URL_SCHEDULER`|`scheduler`|
 |EventBridge Schemas|`schemas`|`AWS_ENDPOINT_URL_SCHEMAS`|`schemas`|
 |Secrets Manager|`secretsmanager`|`AWS_ENDPOINT_URL_SECRETS_MANAGER`|`secrets_manager`|
@@ -457,4 +457,4 @@ class MyConvertedCode(TerraformStack):
         )
 ```
 
-<!-- cache-key: cdktf-0.20.8 input-97c3cb707d3a062177488b18e495f9ee8ec86f4e047798c29565c3ba117a5c1a -->
+<!-- cache-key: cdktf-0.20.8 input-11399ce897c01f5968f8952f815f4ac55d3fb7cbb6ba03da989e19ca3c04e49f -->
diff --git a/website/docs/cdktf/python/index.html.markdown b/website/docs/cdktf/python/index.html.markdown
@@ -13,7 +13,7 @@ Use the Amazon Web Services (AWS) provider to interact with the
 many resources supported by AWS. You must configure the provider
 with the proper credentials before you can use it.
 
-Use the navigation to the left to read about the available resources. There are currently 1487 resources and 599 data sources available in the provider.
+Use the navigation to the left to read about the available resources. There are currently 1492 resources and 599 data sources available in the provider.
 
 To learn the basics of Terraform using this provider, follow the
 hands-on [get started tutorials](https://learn.hashicorp.com/tutorials/terraform/infrastructure-as-code?in=terraform/aws-get-started&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). Interact with AWS services,
@@ -898,4 +898,4 @@ Approaches differ per authentication providers:
       There used to be no better way to get account ID out of the API
       when using the federated account until `sts:GetCallerIdentity` was introduced.
 
-<!-- cache-key: cdktf-0.20.8 input-e099add3ea6a900d92a728080e0396d45e20daf3acaf3b809366bde27c5795dc -->
+<!-- cache-key: cdktf-0.20.8 input-7b6cd1f812e7be9e6821bafc9f3596739b48f965631c2129ab8d1a0eaba63518 -->