Merge pull request #38278 from hashicorp/d-cdktf-docs-9831365892-98

cdktf: update documentation

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

@@ -0,0 +1,88 @@
+---
+subcategory: "AppStream 2.0"
+layout: "aws"
+page_title: "AWS: aws_appstream_image"
+description: |-
+  Terraform data source for describing an AWS AppStream 2.0 Appstream Image.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: aws_appstream_image
+
+Terraform data source for managing an AWS AppStream 2.0 Image.
+
+### 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_appstream_image import DataAwsAppstreamImage
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataAwsAppstreamImage(self, "test",
+            most_recent=True,
+            name="AppStream-WinServer2019-06-17-2024",
+            type="PUBLIC"
+        )
+```
+
+## Argument Reference
+
+The following arguments are optional:
+
+* `name` - Name of the image being searched for. Cannot be used with name_regex or arn.
+* `name_regex` - Regular expression name of the image being searched for. Cannot be used with arn or name.
+* `arn` - Arn of the image being searched for. Cannot be used with name_regex or name.
+* `type` - The type of image which must be (PUBLIC, PRIVATE, or SHARED).
+* `most_recent` - Boolean that if it is set to true and there are multiple images returned the most recent will be returned. If it is set to false and there are multiple images return the datasource will error.
+
+## Attribute Reference
+
+This data source exports the following attributes in addition to the arguments above:
+
+* `application` - A application object that contains the following:
+    * `app_block_arn` - The app block ARN of the application.
+    * `created_time` - The time at which the application was created within the app block.
+    * `description` - The description of the application.
+    * `display_name` - The application name to display.
+    * `enabled` - Bool based on if the application is enabled.
+    * `icon_s3_location` - A list named icon_s3_location that contains the following:
+        * `s3_bucket` - S3 bucket of the S3 object.
+        * `s3_key` - S3 key of the S3 object.
+    * `icon_url` - URL of the application icon. This URL may be time-limited.
+    * `instance_families` - List of the instance families of the application.
+    * `launch_parameters` - Arguments that are passed to the application at it's launch.
+    * `launch_path` -  Path to the application's excecutable in the instance.
+    * `metadata` - String to string map that contains additional attributes used to describe the application.
+    * `Name` - Name of the application.
+    * `platforms` - Array of strings describing the platforms on which the application can run.
+      Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
+    * `working_directory` - Working directory for the application.
+* `appstream_agent_version` - Version of the AppStream 2.0 agent to use for instances that are launched from this image. Has a maximum length of 100 characters.
+* `arn` - ARN of the image.
+* `base_image_arn` - ARN of the image from which the image was created.
+* `created_time` - Time at which this image was created.
+* `description` - Description of image.
+* `display_name` - Image name to display.
+* `image_builder_name` - The name of the image builder that was used to created the private image. If the image is sharedthen the value is null.
+* `image_builder_supported` - Boolean to indicate whether an image builder can be launched from this image.
+* `image error` - Resource error object that describes the error containing the following:
+    * `error_code` - Error code of the image. Values will be from: IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION | IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION | IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION | NETWORK_INTERFACE_LIMIT_EXCEEDED | INTERNAL_SERVICE_ERROR | IAM_SERVICE_ROLE_IS_MISSING | MACHINE_ROLE_IS_MISSING | STS_DISABLED_IN_REGION | SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES | IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION | SUBNET_NOT_FOUND | IMAGE_NOT_FOUND | INVALID_SUBNET_CONFIGURATION | SECURITY_GROUPS_NOT_FOUND | IGW_NOT_ATTACHED | IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION | FLEET_STOPPED | FLEET_INSTANCE_PROVISIONING_FAILURE | DOMAIN_JOIN_ERROR_FILE_NOT_FOUND | DOMAIN_JOIN_ERROR_ACCESS_DENIED | DOMAIN_JOIN_ERROR_LOGON_FAILURE | DOMAIN_JOIN_ERROR_INVALID_PARAMETER | DOMAIN_JOIN_ERROR_MORE_DATA | DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN | DOMAIN_JOIN_ERROR_NOT_SUPPORTED | DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME | DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED | DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED | DOMAIN_JOIN_NERR_PASSWORD_EXPIRED | DOMAIN_JOIN_INTERNAL_SERVICE_ERROR as the values.
+    * `error_message` - Error message of the image.
+    * `error_timestamp` - Time when the error occurred.
+* `image_permissions` - List of strings describing the image permissions containing the following:
+    * `allow_fleet` - Boolean indicating if the image can be used for a fleet.
+    * `allow_image_builder` - indicated whether the image can be used for an image builder.
+* `platform` - Operating system platform of the image. Values will be from: WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | AMAZON_LINUX2
+* `public_image_released_date` - Release date of base image if public. For private images, it is the release date of the base image that it was created from.
+* `state` - Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING.
+* `visibility` - Visibility type enum indicating whether the image is PUBLIC, PRIVATE, or SHARED. Valid values include: PUBLIC | PRIVATE | SHARED.
+
+<!-- cache-key: cdktf-0.20.1 input-39f03a832e6704e24654ff2ffaed108e62f2139a01511d5bb7d35829e13a0986 -->

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

@@ -43,7 +43,8 @@ This data source exports the following attributes in addition to the arguments a
 
 * `arn` - ARN of the backup plan.
 * `name` - Display name of a backup plan.
+* `rule` - Rules of a backup plan.
 * `tags` - Metadata that you can assign to help organize the plans you create.
 * `version` - Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.
 
-<!-- cache-key: cdktf-0.20.1 input-57458a8d2ad23e0db1998b3c24bffe8d7a9e84c173a10afd8dcf9f9009620a99 -->
+<!-- cache-key: cdktf-0.20.1 input-7c9faa1009394bae11fe135d4c10cca75cdf7772457b91405575d687d1d6ef9a -->

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

@@ -60,19 +60,19 @@ Each document configuration may have one or more `rule` blocks, which each accep
 * `action` (Optional) - Specifies the action type.
     * `type` (Required) - The supported value is `expire`.
 * `description` (Optional) - Describes the purpose of a rule within a lifecycle policy.
-* `priority` (Required) - Sets the order in which rules are evaluated, lowest to highest. When you add rules to a lifecycle policy, you must give them each a unique value for `priority`. Values do not need to be sequential across rules in a policy. A rule with a `tag_status` value of any must have the highest value for `priority` and be evaluated last.
+* `priority` (Required) - Sets the order in which rules are evaluated, lowest to highest. When you add rules to a lifecycle policy, you must give them each a unique value for `priority`. Values do not need to be sequential across rules in a policy. A rule with a `tag_status` value of "any" must have the highest value for `priority` and be evaluated last.
 * `selection` (Required) -  Collects parameters describing the selection criteria for the ECR lifecycle policy:
-    * `tag_status` (Required) - Determines whether the lifecycle policy rule that you are adding specifies a tag for an image. Acceptable options are tagged, untagged, or any. If you specify any, then all images have the rule applied to them. If you specify tagged, then you must also specify a `tag_prefix_list` value. If you specify untagged, then you must omit `tag_prefix_list`.
-    * `tag_pattern_list` (Required if `tag_status` is set to tagged and `tag_prefix_list` isn't specified) - You must specify a comma-separated list of image tag patterns that may contain wildcards (*) on which to take action with your lifecycle policy. For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag pattern list prod* to specify all of them. If you specify multiple tags, only the images with all specified tags are selected. There is a maximum limit of four wildcards (*) per string. For example, ["*test*1*2*3", "test*1*2*3*"] is valid but ["test*1*2*3*4*5*6"] is invalid.
-    * `tag_prefix_list` (Required if `tag_status` is set to tagged and `tag_pattern_list` isn't specified) - You must specify a comma-separated list of image tag prefixes on which to take action with your lifecycle policy. For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag prefix prod to specify all of them. If you specify multiple tags, only images with all specified tags are selected.
-    * `count_type` (Required) - Specify a count type to apply to the images. If `count_type` is set to imageCountMoreThan, you also specify `count_number` to create a rule that sets a limit on the number of images that exist in your repository. If `count_type` is set to sinceImagePushed, you also specify `count_unit` and `count_number` to specify a time limit on the images that exist in your repository.
-    * `count_unit` (Required if `count_type` is set to sinceImagePushed) - Specify a count unit of days to indicate that as the unit of time, in addition to `count_number`, which is the number of days.
-    * `count_number` (Required) - Specify a count number. If the `count_type` used is imageCountMoreThan, then the value is the maximum number of images that you want to retain in your repository. If the `count_type` used is sinceImagePushed, then the value is the maximum age limit for your images.
+    * `tag_status` (Required) - Determines whether the lifecycle policy rule that you are adding specifies a tag for an image. Acceptable options are "tagged", "untagged", or "any". If you specify "any", then all images have the rule applied to them. If you specify "tagged", then you must also specify a `tag_prefix_list` value. If you specify "untagged", then you must omit `tag_prefix_list`.
+    * `tag_pattern_list` (Required if `tag_status` is set to "tagged" and `tag_prefix_list` isn't specified) - You must specify a comma-separated list of image tag patterns that may contain wildcards (\*) on which to take action with your lifecycle policy. For example, if your images are tagged as `prod`, `prod1`, `prod2`, and so on, you would use the tag pattern list `["prod\*"]` to specify all of them. If you specify multiple tags, only the images with all specified tags are selected. There is a maximum limit of four wildcards (\*) per string. For example, `["*test*1*2*3", "test*1*2*3*"]` is valid but `["test*1*2*3*4*5*6"]` is invalid.
+    * `tag_prefix_list` (Required if `tag_status` is set to "tagged" and `tag_pattern_list` isn't specified) - You must specify a comma-separated list of image tag prefixes on which to take action with your lifecycle policy. For example, if your images are tagged as `prod`, `prod1`, `prod2`, and so on, you would use the tag prefix "prod" to specify all of them. If you specify multiple tags, only images with all specified tags are selected.
+    * `count_type` (Required) - Specify a count type to apply to the images. If `count_type` is set to "imageCountMoreThan", you also specify `count_number` to create a rule that sets a limit on the number of images that exist in your repository. If `count_type` is set to "sinceImagePushed", you also specify `count_unit` and `count_number` to specify a time limit on the images that exist in your repository.
+    * `count_unit` (Required if `count_type` is set to "sinceImagePushed") - Specify a count unit of days to indicate that as the unit of time, in addition to `count_number`, which is the number of days.
+    * `count_number` (Required) - Specify a count number. If the `count_type` used is "imageCountMoreThan", then the value is the maximum number of images that you want to retain in your repository. If the `count_type` used is "sinceImagePushed", then the value is the maximum age limit for your images.
 
 ## Attribute Reference
 
 This data source exports the following attributes in addition to the arguments above:
 
 * `json` - The above arguments serialized as a standard JSON policy document.
 
-<!-- cache-key: cdktf-0.20.1 input-75182ef7152aaa6cce22d6cf722fdf5a91a35ff727574047101fd54d8ca3ae5b -->
+<!-- cache-key: cdktf-0.20.1 input-2eca66697e1ebf6034d0c5aa2609e2afb358f5b7d5039c5bc9c79009b3a4c09b -->

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

@@ -48,7 +48,9 @@ In addition to all arguments above, the following attributes are exported:
 * `daily_automatic_backup_start_time` - The preferred time (in `HH:MM` format) to take daily automatic backups, in the UTC time zone.
 * `deployment_type` - The file system deployment type.
 * `disk_iops_configuration` - The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See [Disk IOPS](#disk-iops) Below.
-* `dns_name` - DNS name for the file system (e.g. `fs-12345678.corp.example.com`).
+* `dns_name` - DNS name for the file system.
+
+  **Note:** This attribute does not apply to FSx for ONTAP file systems and is consequently not set. You can access your FSx for ONTAP file system and volumes via a [Storage Virtual Machine (SVM)](fsx_ontap_storage_virtual_machine.html) using its DNS name or IP address.
 * `endpoint_ip_address_range` - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
 * `endpoints` - The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See [FileSystemEndpoints](#file-system-endpoints) below.
 * `ha_pairs` - The number of HA pairs for the file system.
@@ -82,4 +84,4 @@ In addition to all arguments above, the following attributes are exported:
 * `DNSName` - The file system's DNS name. You can mount your file system using its DNS name.
 * `IpAddresses` - IP addresses of the file system endpoint.
 
-<!-- cache-key: cdktf-0.20.1 input-61ee4666c4715dc5142dd755e5c30e597669f668aa73e98d4ecdf85468818540 -->
+<!-- cache-key: cdktf-0.20.1 input-b97463809c57c7b63b418b0676e4e2a48d4f96734b55866c6060f2c5662073a5 -->

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

@@ -54,6 +54,7 @@ This data source exports the following attributes in addition to the arguments a
     * `http_put_response_hop_limit` - The desired HTTP PUT response hop limit for instance metadata requests.
 * `security_groups` - List of associated Security Group IDS.
 * `associate_public_ip_address` - Whether a Public IP address is associated with the instance.
+* `primary_ipv6` - Whether the first IPv6 GUA will be made the primary IPv6 address.
 * `user_data` - User Data of the instance.
 * `enable_monitoring` - Whether Detailed Monitoring is Enabled.
 * `ebs_optimized` - Whether the launched EC2 instance will be EBS-optimized.
@@ -89,4 +90,4 @@ This data source exports the following attributes in addition to the arguments a
 * `device_name` - Name of the device.
 * `virtual_name` - Virtual Name of the device.
 
-<!-- cache-key: cdktf-0.20.1 input-e1cd93bfea359bae7e967acc82a26e1a08ef38531f91dbee6e143392ac081f6b -->
+<!-- cache-key: cdktf-0.20.1 input-0f7904ad6942115d54298c7ae804e89f82902ce14639bff2f34ee2ea3c0c7e22 -->

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

@@ -44,10 +44,11 @@ The following arguments are required:
 This data source exports the following attributes in addition to the arguments above:
 
 * `arn` - ARN of the link.
+* `id` - ARN of the link.
 * `label` - Label that is assigned to this link.
 * `label_template` - Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
 * `link_id` - ID string that AWS generated as part of the link ARN.
 * `resource_types` - Types of data that the source account shares with the monitoring account.
 * `sink_arn` - ARN of the sink that is used for this link.
 
-<!-- cache-key: cdktf-0.20.1 input-26fcd6d6196bf524f0cfb96d5f07e971f686ef152091f112f43b672b61693a13 -->
+<!-- cache-key: cdktf-0.20.1 input-939e99dcdae2633617c92153ba17ae464e5b8bc7ffb9ad55b2deadc8e09f9fb4 -->

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

@@ -44,8 +44,9 @@ The following arguments are required:
 This data source exports the following attributes in addition to the arguments above:
 
 * `arn` - ARN of the sink.
+* `id` - ARN of the sink.
 * `name` - Name of the sink.
 * `sink_id` - Random ID string that AWS generated as part of the sink ARN.
 * `tags` - Tags assigned to the sink.
 
-<!-- cache-key: cdktf-0.20.1 input-a4f5dba9c965dac580e8ea80924e17cc8d99e843f54e4829277a40c5b1d4e297 -->
+<!-- cache-key: cdktf-0.20.1 input-8e63be540533d9d78bac454b3d644795733c12ad84f0bb46cc6b5785db3cbc59 -->