Merge pull request #26591 from hashicorp/t-docs-clean

docs: Clean up articles

docs/adding-a-tag-resource.md

@@ -156,7 +156,7 @@ resource "aws_{service}_tag" "example" {
 
 The following arguments are supported:
 
-* `resource_arn` - (Required) Amazon Resource Name (ARN) of the {SERVICE} resource to tag.
+* `resource_arn` - (Required) ARN of the {SERVICE} resource to tag.
 * `key` - (Required) Tag name.
 * `value` - (Required) Tag value.
 

docs/provider-design.md

@@ -93,7 +93,7 @@ For some AWS components, the AWS API allows specifying an [IAM resource-based po
 
 Provider developers should implement this capability in a new resource rather than adding it to the associated resource. Reasons for this include:
 
-* Many of the policies must include the Amazon Resource Name (ARN) of the resource. Working around this requirement with custom difference handling within a self-contained resource is unnecessarily cumbersome.
+* Many of the policies must include the ARN of the resource. Working around this requirement with custom difference handling within a self-contained resource is unnecessarily cumbersome.
 * Some policies involving multiple resources need to cross-reference each other's ARNs. Without a separate resource, this introduces a configuration cycle.
 * Splitting the resources allows operators to logically split their configurations into purely operational and security boundaries. This allows environments to have distinct practitioners roles and permissions for IAM versus infrastructure changes.
 

docs/raising-a-pull-request.md

@@ -147,7 +147,7 @@ This Contribution Guide also includes separate sections on topics such as [Error
 
 The below are style-based items that _may_ be noted during review and are recommended for simplicity, consistency, and quality assurance:
 
-- __Implements arn Attribute__: APIs that return an Amazon Resource Name (ARN) should implement `arn` as an attribute. Alternatively, the ARN can be synthesized using the AWS Go SDK [`arn.ARN`](https://docs.aws.amazon.com/sdk-for-go/api/aws/arn/#ARN) structure. For example:
+- __Implements arn Attribute__: APIs that return an ARN should implement `arn` as an attribute. Alternatively, the ARN can be synthesized using the AWS Go SDK [`arn.ARN`](https://docs.aws.amazon.com/sdk-for-go/api/aws/arn/#ARN) structure. For example:
 
   ```go
   // Direct Connect Virtual Interface ARN.

docs/resource-filtering.md

@@ -54,7 +54,7 @@ input.Filters = filters.EC2Filters()
 
 More complex filters can be expressed using one or more `filter` sub-blocks, which take the following arguments:
 
-* `name` - (Required) The name of the field to filter by, as defined by
+* `name` - (Required) Name of the field to filter by, as defined by
   [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html).
 
 * `values` - (Required) Set of values that are accepted for the given field.

internal/service/ec2/vpc_security_group_test.go

@@ -1967,9 +1967,8 @@ func TestAccVPCSecurityGroup_failWithDiffMismatch(t *testing.T) {
 var ruleLimit int
 
 // testAccSecurityGroup_ruleLimit sets the global "ruleLimit" and is only called once
-// but does not run in parallel slowing down tests. The mutex limits it to one slow down
-// instead of one per test. It cannot run in parallel since it is called by another test
-// and double paralleling is a panic.
+// but does not run in parallel slowing down tests. It cannot run in parallel since
+// it is called by another test and double paralleling is a panic.
 func testAccSecurityGroup_ruleLimit(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { acctest.PreCheck(t) },

website/docs/d/acm_certificate.html.markdown

@@ -37,19 +37,19 @@ data "aws_acm_certificate" "rsa_4096" {
 
 ## Argument Reference
 
-* `domain` - (Required) The domain of the certificate to look up. If no certificate is found with this name, an error will be returned.
-* `key_types` - (Optional) A list of key algorithms to filter certificates. By default, ACM does not return all certificate types when searching. See the [ACM API Reference](https://docs.aws.amazon.com/acm/latest/APIReference/API_CertificateDetail.html#ACM-Type-CertificateDetail-KeyAlgorithm) for supported key algorithms.
-* `statuses` - (Optional) A list of statuses on which to filter the returned list. Valid values are `PENDING_VALIDATION`, `ISSUED`,
+* `domain` - (Required) Domain of the certificate to look up. If no certificate is found with this name, an error will be returned.
+* `key_types` - (Optional) List of key algorithms to filter certificates. By default, ACM does not return all certificate types when searching. See the [ACM API Reference](https://docs.aws.amazon.com/acm/latest/APIReference/API_CertificateDetail.html#ACM-Type-CertificateDetail-KeyAlgorithm) for supported key algorithms.
+* `statuses` - (Optional) List of statuses on which to filter the returned list. Valid values are `PENDING_VALIDATION`, `ISSUED`,
    `INACTIVE`, `EXPIRED`, `VALIDATION_TIMED_OUT`, `REVOKED` and `FAILED`. If no value is specified, only certificates in the `ISSUED` state
    are returned.
-* `types` - (Optional) A list of types on which to filter the returned list. Valid values are `AMAZON_ISSUED` and `IMPORTED`.
+* `types` - (Optional) List of types on which to filter the returned list. Valid values are `AMAZON_ISSUED` and `IMPORTED`.
 * `most_recent` - (Optional) If set to true, it sorts the certificates matched by previous criteria by the NotBefore field, returning only the most recent one. If set to false, it returns an error if more than one certificate is found. Defaults to false.
 
 ## Attributes Reference
 
-* `arn` - Amazon Resource Name (ARN) of the found certificate, suitable for referencing in other resources that support ACM certificates.
-* `id` - Amazon Resource Name (ARN) of the found certificate, suitable for referencing in other resources that support ACM certificates.
+* `arn` - ARN of the found certificate, suitable for referencing in other resources that support ACM certificates.
+* `id` - ARN of the found certificate, suitable for referencing in other resources that support ACM certificates.
 * `status` - Status of the found certificate.
-* `certificate` - The ACM-issued certificate.
+* `certificate` - ACM-issued certificate.
 * `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` - A mapping of tags for the resource.
+* `tags` - Mapping of tags for the resource.

website/docs/d/acmpca_certificate.html.markdown

@@ -23,12 +23,12 @@ data "aws_acmpca_certificate" "example" {
 
 The following arguments are supported:
 
-* `arn` - (Required) Amazon Resource Name (ARN) of the certificate issued by the private certificate authority.
-* `certificate_authority_arn` - (Required) Amazon Resource Name (ARN) of the certificate authority.
+* `arn` - (Required) ARN of the certificate issued by the private certificate authority.
+* `certificate_authority_arn` - (Required) ARN of the certificate authority.
 
 ## Attribute Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-* `certificate` - The PEM-encoded certificate value.
-* `certificate_chain` - The PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA.
+* `certificate` - PEM-encoded certificate value.
+* `certificate_chain` - PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA.

website/docs/d/acmpca_certificate_authority.html.markdown

@@ -22,13 +22,13 @@ data "aws_acmpca_certificate_authority" "example" {
 
 The following arguments are supported:
 
-* `arn` - (Required) Amazon Resource Name (ARN) of the certificate authority.
+* `arn` - (Required) ARN of the certificate authority.
 
 ## Attribute Reference
 
 In addition to all arguments above, the following attributes are exported:
 
-* `id` - Amazon Resource Name (ARN) of the certificate authority.
+* `id` - ARN of the certificate authority.
 * `certificate` - Base64-encoded certificate authority (CA) certificate. Only available after the certificate authority certificate has been imported.
 * `certificate_chain` - Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. Only available after the certificate authority certificate has been imported.
 * `certificate_signing_request` - The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.
@@ -45,5 +45,5 @@ In addition to all arguments above, the following attributes are exported:
         * `revocation_configuration.0.ocsp_configuration.0.ocsp_custom_cname` - A CNAME specifying a customized OCSP domain.
 * `serial` - Serial number of the certificate authority. Only available after the certificate authority certificate has been imported.
 * `status` - Status of the certificate authority.
-* `tags` - Specifies a key-value map of user-defined tags that are attached to the certificate authority.
-* `type` - The type of the certificate authority.
+* `tags` - Key-value map of user-defined tags that are attached to the certificate authority.
+* `type` - Type of the certificate authority.

website/docs/d/ami.html.markdown

@@ -53,7 +53,7 @@ recent AMI.
 several valid keys, for a full reference, check out
 [describe-images in the AWS CLI reference][1].
 
-* `name_regex` - (Optional) A regex string to apply to the AMI list returned
+* `name_regex` - (Optional) Regex string to apply to the AMI list returned
 by AWS. This allows more advanced filtering not supported from the AWS API. This
 filtering is done locally on what AWS returns, and could have a performance
 impact if the result is large. Combine this with other
@@ -72,11 +72,11 @@ are exported:
 ~> **NOTE:** Some values are not always set and may not be available for
 interpolation.
 
-* `arn` - The ARN of the AMI.
-* `architecture` - The OS architecture of the AMI (ie: `i386` or `x86_64`).
-* `boot_mode` - The boot mode of the image.
+* `arn` - ARN of the AMI.
+* `architecture` - OS architecture of the AMI (ie: `i386` or `x86_64`).
+* `boot_mode` - Boot mode of the image.
 * `block_device_mappings` - Set of objects with block device mappings of the AMI.
-    * `device_name` - The physical name of the device.
+    * `device_name` - Physical name of the device.
     * `ebs` - Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., `ebs.volume_size` or `ebs["volume_size"]`) rather than accessed through the first element of a list (e.g., `ebs[0].volume_size`).
         * `delete_on_termination` - `true` if the EBS volume will be deleted on termination.
         * `encrypted` - `true` if the EBS volume is encrypted.
@@ -86,47 +86,47 @@ interpolation.
         * `throughput` - The throughput that the EBS volume supports, in MiB/s.
         * `volume_type` - The volume type.
     * `no_device` - Suppresses the specified device included in the block device mapping of the AMI.
-    * `virtual_name` - The virtual device name (for instance stores).
-* `creation_date` - The date and time the image was created.
-* `deprecation_time` - The date and time when the image will be deprecated.
-* `description` - The description of the AMI that was provided during image
+    * `virtual_name` - Virtual device name (for instance stores).
+* `creation_date` - Date and time the image was created.
+* `deprecation_time` - Date and time when the image will be deprecated.
+* `description` - Description of the AMI that was provided during image
   creation.
-* `hypervisor` - The hypervisor type of the image.
-* `image_id` - The ID of the AMI. Should be the same as the resource `id`.
-* `image_location` - The location of the AMI.
-* `image_owner_alias` - The AWS account alias (for example, `amazon`, `self`) or
+* `hypervisor` - Hypervisor type of the image.
+* `image_id` - ID of the AMI. Should be the same as the resource `id`.
+* `image_location` - Location of the AMI.
+* `image_owner_alias` - AWS account alias (for example, `amazon`, `self`) or
   the AWS account ID of the AMI owner.
-* `image_type` - The type of image.
-* `kernel_id` - The kernel associated with the image, if any. Only applicable
+* `image_type` - Type of image.
+* `kernel_id` - Kernel associated with the image, if any. Only applicable
   for machine images.
-* `name` - The name of the AMI that was provided during image creation.
-* `owner_id` - The AWS account ID of the image owner.
-* `platform` - The value is Windows for `Windows` AMIs; otherwise blank.
+* `name` - Name of the AMI that was provided during image creation.
+* `owner_id` - AWS account ID of the image owner.
+* `platform` - Value is Windows for `Windows` AMIs; otherwise blank.
 * `product_codes` - Any product codes associated with the AMI.
     * `product_codes.#.product_code_id` - The product code.
     * `product_codes.#.product_code_type` - The type of product code.
 * `public` - `true` if the image has public launch permissions.
-* `ramdisk_id` - The RAM disk associated with the image, if any. Only applicable
+* `ramdisk_id` - RAM disk associated with the image, if any. Only applicable
   for machine images.
-* `root_device_name` - The device name of the root device.
-* `root_device_type` - The type of root device (ie: `ebs` or `instance-store`).
-* `root_snapshot_id` - The snapshot id associated with the root device, if any
+* `root_device_name` - Device name of the root device.
+* `root_device_type` - Type of root device (ie: `ebs` or `instance-store`).
+* `root_snapshot_id` - Snapshot id associated with the root device, if any
   (only applies to `ebs` root devices).
-* `sriov_net_support` - Specifies whether enhanced networking is enabled.
-* `state` - The current state of the AMI. If the state is `available`, the image
+* `sriov_net_support` - Whether enhanced networking is enabled.
+* `state` - Current state of the AMI. If the state is `available`, the image
   is successfully registered and can be used to launch an instance.
 * `state_reason` - Describes a state change. Fields are `UNSET` if not available.
     * `state_reason.code` - The reason code for the state change.
     * `state_reason.message` - The message for the state change.
 * `tags` - Any tags assigned to the image.
-    * `tags.#.key` - The key name of the tag.
-    * `tags.#.value` - The value of the tag.
+    * `tags.#.key` - Key name of the tag.
+    * `tags.#.value` - Value of the tag.
 * `tpm_support` - If the image is configured for NitroTPM support, the value is `v2.0`.
-* `virtualization_type` - The type of virtualization of the AMI (ie: `hvm` or
+* `virtualization_type` - Type of virtualization of the AMI (ie: `hvm` or
   `paravirtual`).
-* `usage_operation` - The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
-* `platform_details` - The platform details associated with the billing code of the AMI.
-* `ena_support` - Specifies whether enhanced networking with ENA is enabled.
+* `usage_operation` - Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
+* `platform_details` - Platform details associated with the billing code of the AMI.
+* `ena_support` - Whether enhanced networking with ENA is enabled.
 
 ## Timeouts
 

website/docs/d/ami_ids.html.markdown

@@ -34,7 +34,7 @@ permission on  the image. Valid items are the numeric account ID or `self`.
 are several valid keys, for a full reference, check out
 [describe-images in the AWS CLI reference][1].
 
-* `name_regex` - (Optional) A regex string to apply to the AMI list returned
+* `name_regex` - (Optional) Regex string to apply to the AMI list returned
 by AWS. This allows more advanced filtering not supported from the AWS API.
 This filtering is done locally on what AWS returns, and could have a performance
 impact if the result is large. Combine this with other

website/docs/d/api_gateway_api_key.html.markdown

@@ -21,15 +21,15 @@ data "aws_api_gateway_api_key" "my_api_key" {
 
 ## Argument Reference
 
-* `id` - (Required) The ID of the API Key to look up.
+* `id` - (Required) ID of the API Key to look up.
 
 ## Attributes Reference
 
 * `id` - Set to the ID of the API Key.
 * `name` - Set to the name of the API Key.
 * `value` - Set to the value of the API Key.
-* `created_date` - The date and time when the API Key was created.
-* `last_updated_date` - The date and time when the API Key was last updated.
-* `description` - The description of the API Key.
-* `enabled` - Specifies whether the API Key is enabled.
-* `tags` - A map of tags for the resource.
+* `created_date` - Date and time when the API Key was created.
+* `last_updated_date` - Date and time when the API Key was last updated.
+* `description` - Description of the API Key.
+* `enabled` - Whether the API Key is enabled.
+* `tags` - Map of tags for the resource.

website/docs/d/api_gateway_export.html.markdown

@@ -20,15 +20,15 @@ data "aws_api_gateway_export" "example" {
 
 ## Argument Reference
 
-* `export_type` - (Required) The type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
-* `rest_api_id` - (Required) The identifier of the associated REST API.
-* `stage_name` - (Required) The name of the Stage that will be exported.
-* `accepts` - (Optional) The content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `export_type` `ofoas30` and `swagger`.
-* `parameters` - (Optional) A key-value map of query string parameters that specify properties of the export. the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions.
+* `export_type` - (Required) Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0.
+* `rest_api_id` - (Required) Identifier of the associated REST API.
+* `stage_name` - (Required) Name of the Stage that will be exported.
+* `accepts` - (Optional) Content-type of the export. Valid values are `application/json` and `application/yaml` are supported for `export_type` `ofoas30` and `swagger`.
+* `parameters` - (Optional) Key-value map of query string parameters that specify properties of the export. the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions.
 
 ## Attributes Reference
 
 * `id` - The `REST-API-ID:STAGE-NAME`
-* `body` - The API Spec.
-* `content_type` - The content-type header value in the HTTP response.
-* `content_disposition` - The content-disposition header value in the HTTP response.
+* `body` - API Spec.
+* `content_type` - Content-type header value in the HTTP response.
+* `content_disposition` - Content-disposition header value in the HTTP response.

website/docs/d/api_gateway_resource.html.markdown

@@ -26,8 +26,8 @@ data "aws_api_gateway_resource" "my_resource" {
 
 ## Argument Reference
 
-* `rest_api_id` - (Required) The REST API id that owns the resource. If no REST API is found, an error will be returned.
-* `path` - (Required) The full path of the resource.  If no path is found, an error will be returned.
+* `rest_api_id` - (Required) REST API id that owns the resource. If no REST API is found, an error will be returned.
+* `path` - (Required) Full path of the resource.  If no path is found, an error will be returned.
 
 ## Attributes Reference