Merge pull request #42706 from hashicorp/d-further-arguments-byline-standardization

ewbankkit · web-flow · commit 82531c22cd75 · 2025-05-21T11:35:43.000-04:00
Documentation: Further `Argument Reference` section byline standardization
diff --git a/website/docs/d/appmesh_virtual_gateway.html.markdown b/website/docs/d/appmesh_virtual_gateway.html.markdown
@@ -33,7 +33,7 @@ data "aws_appmesh_virtual_gateway" "test" {
 
 ## Argument Reference
 
-The following arguments are required:
+This data source supports the following arguments:
 
 * `name` - (Required) Name of the virtual gateway.
 * `mesh_name` - (Required) Name of the service mesh in which the virtual gateway exists.
diff --git a/website/docs/d/datazone_domain.html.markdown b/website/docs/d/datazone_domain.html.markdown
@@ -22,7 +22,7 @@ data "aws_datazone_domain" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This data source supports the following arguments:
 
 * `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
diff --git a/website/docs/d/dx_router_configuration.html.markdown b/website/docs/d/dx_router_configuration.html.markdown
@@ -23,7 +23,7 @@ data "aws_dx_router_configuration" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `virtual_interface_id` - (Required) ID of the Direct Connect Virtual Interface
 * `router_type_identifier` - (Required) ID of the Router Type. For example: `CiscoSystemsInc-2900SeriesRouters-IOS124`
diff --git a/website/docs/r/appfabric_app_authorization.html.markdown b/website/docs/r/appfabric_app_authorization.html.markdown
@@ -34,7 +34,7 @@ resource "aws_appfabric_app_authorization" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `app` - (Required) The name of the application for valid values see https://docs.aws.amazon.com/appfabric/latest/api/API_CreateAppAuthorization.html.
 * `app_bundle_arn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request.
diff --git a/website/docs/r/appfabric_ingestion.html.markdown b/website/docs/r/appfabric_ingestion.html.markdown
@@ -28,7 +28,7 @@ resource "aws_appfabric_ingestion" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `app` - (Required) Name of the application.
 Refer to the AWS Documentation for the [list of valid values](https://docs.aws.amazon.com/appfabric/latest/api/API_CreateIngestion.html#appfabric-CreateIngestion-request-app)
diff --git a/website/docs/r/appfabric_ingestion_destination.html.markdown b/website/docs/r/appfabric_ingestion_destination.html.markdown
@@ -40,7 +40,7 @@ resource "aws_appfabric_ingestion_destination" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `app_bundle_arn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request.
 * `ingestion_arn` - (Required) The Amazon Resource Name (ARN) of the ingestion to use for the request.
diff --git a/website/docs/r/backup_logically_air_gapped_vault.html.markdown b/website/docs/r/backup_logically_air_gapped_vault.html.markdown
@@ -24,7 +24,7 @@ resource "aws_backup_logically_air_gapped_vault" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `name` - (Required) Name of the Logically Air Gapped Backup Vault to create.
 * `max_retention_days` - (Required) Maximum retention period that the Logically Air Gapped Backup Vault retains recovery points.
diff --git a/website/docs/r/ce_anomaly_monitor.html.markdown b/website/docs/r/ce_anomaly_monitor.html.markdown
@@ -51,7 +51,7 @@ resource "aws_ce_anomaly_monitor" "test" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `name` - (Required) The name of the monitor.
 * `monitor_type` - (Required) The possible type values. Valid values: `DIMENSIONAL` | `CUSTOM`.
diff --git a/website/docs/r/ce_anomaly_subscription.html.markdown b/website/docs/r/ce_anomaly_subscription.html.markdown
@@ -206,7 +206,7 @@ resource "aws_ce_anomaly_subscription" "realtime_subscription" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `account_id` - (Optional) The unique identifier for the AWS account in which the anomaly subscription ought to be created.
 * `frequency` - (Required) The frequency that anomaly reports are sent. Valid Values: `DAILY` | `IMMEDIATE` | `WEEKLY`.
diff --git a/website/docs/r/ce_cost_category.html.markdown b/website/docs/r/ce_cost_category.html.markdown
@@ -56,11 +56,11 @@ The following arguments are required:
 * `name` - (Required) Unique name for the Cost Category.
 * `rule` - (Required) Configuration block for the Cost Category rules used to categorize costs. See below.
 * `rule_version` - (Required) Rule schema version in this particular Cost Category.
-* `effective_start`- (Optional)  The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future. For example `2022-11-01T00:00:00Z`.
 
 The following arguments are optional:
 
 * `default_value` - (Optional) Default value for the cost category.
+* `effective_start`- (Optional)  The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future. For example `2022-11-01T00:00:00Z`.
 * `split_charge_rule` - (Optional) Configuration block for the split charge rules used to allocate your charges between your Cost Category values. See below.
 * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
 
diff --git a/website/docs/r/cloudfront_origin_access_control.html.markdown b/website/docs/r/cloudfront_origin_access_control.html.markdown
@@ -28,7 +28,7 @@ resource "aws_cloudfront_origin_access_control" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `name` - (Required) A name that identifies the Origin Access Control.
 * `description` - (Optional) The description of the Origin Access Control. Defaults to "Managed by Terraform" if omitted.
diff --git a/website/docs/r/datazone_environment_profile.html.markdown b/website/docs/r/datazone_environment_profile.html.markdown
@@ -107,17 +107,14 @@ resource "aws_datazone_environment_profile" "test" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `aws_account_id` - (Required) -  Id of the AWS account being used.
 * `aws_account_region` - (Required) -  Desired region for environment profile.
 * `domain_identifier` - (Required) -  Domain Identifier for environment profile.
 * `name` - (Required) -  Name of the environment profile.
 * `environment_blueprint_identifier` - (Required) -  ID of the blueprint which the environment will be created with.
 * `project_identifier` - (Required) -  Project identifier for environment profile.
-
-The following arguments are optional:
-
 * `description` - (Optional) Description of environment profile.
 * `user_parameters` - (Optional) -  Array of user parameters of the environment profile with the following attributes:
     * `name` - (Required) -  Name of the environment profile parameter.
diff --git a/website/docs/r/dms_s3_endpoint.html.markdown b/website/docs/r/dms_s3_endpoint.html.markdown
@@ -96,10 +96,8 @@ resource "aws_dms_s3_endpoint" "example" {
 The following arguments are required:
 
 * `bucket_name` - (Required) S3 bucket name.
-* `cdc_path` - (Required for CDC; otherwise, Optional) Folder path of CDC files. If `cdc_path` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later.
 * `endpoint_id` - (Required) Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens.
 * `endpoint_type` - (Required) Type of endpoint. Valid values are `source`, `target`.
-* `external_table_definition` - (Required for `source` endpoints; otherwise, Optional) JSON document that describes how AWS DMS should interpret the data.
 * `service_access_role_arn` - (Required) ARN of the IAM role with permissions to the S3 Bucket.
 
 The following arguments are optional:
@@ -112,6 +110,7 @@ The following arguments are optional:
 * `cdc_inserts_only` - (Optional) Whether to write insert operations to .csv or .parquet output files. Default is `false`.
 * `cdc_max_batch_interval` - (Optional) Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. (AWS default is `60`.)
 * `cdc_min_file_size` - (Optional) Minimum file size condition as defined in kilobytes to output a file to Amazon S3. (AWS default is 32000 KB.)
+* `cdc_path` - (Optional) Folder path of CDC files. If `cdc_path` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later. Required for CDC.
 * `certificate_arn` - (Optional, Default: empty string) ARN for the certificate.
 * `compression_type` - (Optional) Set to compress target files. Valid values are `GZIP` and `NONE`. Default is `NONE`. (Ignored for source endpoints.)
 * `csv_delimiter` - (Optional) Delimiter used to separate columns in the source files. Default is `,`.
@@ -130,6 +129,7 @@ The following arguments are optional:
 * `encoding_type` - (Optional) Type of encoding to use. Value values are `rle_dictionary`, `plain`, and `plain_dictionary`. (AWS default is `rle_dictionary`.)
 * `encryption_mode` - (Optional) Server-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values are `SSE_S3` and `SSE_KMS`. (AWS default is `SSE_S3`.) (Ignored for source endpoints -- only `SSE_S3` is valid.)
 * `expected_bucket_owner` - (Optional) Bucket owner to prevent sniping. Value is an AWS account ID.
+* `external_table_definition` - (Optional) JSON document that describes how AWS DMS should interpret the data. Required for `source` endpoints.
 * `glue_catalog_generation` - (Optional) Whether to integrate AWS Glue Data Catalog with an Amazon S3 target. See [Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.GlueCatalog) for more information. Default is `false`.
 * `ignore_header_rows` - (Optional, Force New) When this value is set to `1`, DMS ignores the first row header in a .csv file. (AWS default is `0`.)
 * `include_op_for_full_load` - (Optional) Whether to enable a full load to write INSERT operations to the .csv output files only to indicate how the rows were added to the source database. Default is `false`.
diff --git a/website/docs/r/ec2_network_insights_path.html.markdown b/website/docs/r/ec2_network_insights_path.html.markdown
@@ -25,12 +25,12 @@ resource "aws_ec2_network_insights_path" "test" {
 The following arguments are required:
 
 * `source` - (Required) ID or ARN of the resource which is the source of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN.
-* `destination` - (Optional) ID or ARN of the resource which is the destination of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN. Either the `destination` argument or the `destination_address` argument in the `filter_at_source` block must be specified.
 * `protocol` - (Required) Protocol to use for analysis. Valid options are `tcp` or `udp`.
 
 The following arguments are optional:
 
 * `source_ip` - (Optional) IP address of the source resource.
+* `destination` - (Optional) ID or ARN of the resource which is the destination of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN. Either the `destination` argument or the `destination_address` argument in the `filter_at_source` block must be specified.
 * `destination_ip` - (Optional) IP address of the destination resource.
 * `destination_port` - (Optional) Destination port to analyze access to.
 * `filter_at_destination` - (Optional) Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify `destination_ip`. See below for details. Note that Terraform performs drift detection on this argument only when the value is provided.
diff --git a/website/docs/r/emr_studio_session_mapping.html.markdown b/website/docs/r/emr_studio_session_mapping.html.markdown
@@ -23,7 +23,7 @@ resource "aws_emr_studio_session_mapping" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `identity_id`- (Optional) The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store.
 * `identity_name` - (Optional) The name of the user or group from the Amazon Web Services SSO Identity Store.
diff --git a/website/docs/r/emrcontainers_job_template.html.markdown b/website/docs/r/emrcontainers_job_template.html.markdown
@@ -33,7 +33,7 @@ resource "aws_emrcontainers_job_template" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `job_template_data` - (Required) The job template data which holds values of StartJobRun API request.
 * `kms_key_arn` - (Optional) The KMS key ARN used to encrypt the job template.
diff --git a/website/docs/r/emrcontainers_virtual_cluster.html.markdown b/website/docs/r/emrcontainers_virtual_cluster.html.markdown
@@ -33,7 +33,7 @@ resource "aws_emrcontainers_virtual_cluster" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `container_provider` - (Required) Configuration block for the container provider associated with your cluster.
 * `name` – (Required) Name of the virtual cluster.
diff --git a/website/docs/r/emrserverless_application.html.markdown b/website/docs/r/emrserverless_application.html.markdown
@@ -61,7 +61,7 @@ resource "aws_emrserverless_application" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `architecture` – (Optional) The CPU architecture of an application. Valid values are `ARM64` or `X86_64`. Default value is `X86_64`.
 * `auto_start_configuration` – (Optional) The configuration for an application to automatically start on job submission.
diff --git a/website/docs/r/glue_catalog_table.html.markdown b/website/docs/r/glue_catalog_table.html.markdown
@@ -87,7 +87,7 @@ The following arguments are required:
 * `name` - (Required) Name of the table. For Hive compatibility, this must be entirely lowercase.
 * `database_name` - (Required) Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
 
-The follow arguments are optional:
+The following arguments are optional:
 
 * `catalog_id` - (Optional) ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
 * `description` - (Optional) Description of the table.
diff --git a/website/docs/r/glue_partition_index.html.markdown b/website/docs/r/glue_partition_index.html.markdown
@@ -109,7 +109,7 @@ resource "aws_glue_partition_index" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `table_name` - (Required) Name of the table. For Hive compatibility, this must be entirely lowercase.
 * `database_name` - (Required) Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
diff --git a/website/docs/r/imagebuilder_component.html.markdown b/website/docs/r/imagebuilder_component.html.markdown
@@ -55,7 +55,7 @@ The following arguments are required:
 * `platform` - (Required) Platform of the component.
 * `version` - (Required) Version of the component.
 
-The following attributes are optional:
+The following arguments are optional:
 
 * `change_description` - (Optional) Change description of the component.
 * `data` - (Optional) Inline YAML string with data of the component. Exactly one of `data` and `uri` can be specified. Terraform will only perform drift detection of its value when present in a configuration.
diff --git a/website/docs/r/imagebuilder_container_recipe.html.markdown b/website/docs/r/imagebuilder_container_recipe.html.markdown
@@ -58,7 +58,7 @@ The following arguments are required:
 * `target_repository` (Required) The destination repository for the container image. Detailed below.
 * `version` (Required) Version of the container recipe.
 
-The following attributes are optional:
+The following arguments are optional:
 
 * `description` - (Optional) The description of the container recipe.
 * `dockerfile_template_data` - (Optional) The Dockerfile template used to build the image as an inline data blob.
diff --git a/website/docs/r/imagebuilder_image_recipe.html.markdown b/website/docs/r/imagebuilder_image_recipe.html.markdown
@@ -53,7 +53,7 @@ The following arguments are required:
 * `parent_image` - (Required) The image recipe uses this image as a base from which to build your customized image. The value can be the base image ARN or an AMI ID.
 * `version` - (Required) The semantic version of the image recipe, which specifies the version in the following format, with numeric values in each position to indicate a specific version: major.minor.patch. For example: 1.0.0.
 
-The following attributes are optional:
+The following arguments are optional:
 
 * `block_device_mapping` - (Optional) Configuration block(s) with block device mappings for the image recipe. Detailed below.
 * `description` - (Optional) Description of the image recipe.
diff --git a/website/docs/r/keyspaces_keyspace.html.markdown b/website/docs/r/keyspaces_keyspace.html.markdown
@@ -22,12 +22,9 @@ resource "aws_keyspaces_keyspace" "example" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `name` - (Required, Forces new resource) The name of the keyspace to be created.
-
-The following arguments are optional:
-
 * `replication_specification` - (Optional) The replication specification of the keyspace.
     * `region_list` - (Optional) Replication regions. If `replication_strategy` is `MULTI_REGION`, `region_list` requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
     * `replication_strategy` - (Required) Replication strategy. Valid values: `SINGLE_REGION` and `MULTI_REGION`.
diff --git a/website/docs/r/memorydb_cluster.html.markdown b/website/docs/r/memorydb_cluster.html.markdown
@@ -33,15 +33,15 @@ resource "aws_memorydb_cluster" "example" {
 The following arguments are required:
 
 * `acl_name` - (Required) The name of the Access Control List to associate with the cluster.
-* `engine` - (Optional) The engine that will run on your nodes. Supported values are `redis` and `valkey`.
-* `engine_version` - (Optional) Version number of the engine to be used for the cluster. Downgrades are not supported.
 * `node_type` - (Required) The compute and memory capacity of the nodes in the cluster. See AWS documentation on [supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html) as well as [vertical scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/cluster-vertical-scaling.html).
 
 The following arguments are optional:
 
 * `auto_minor_version_upgrade` - (Optional, Forces new resource) When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`.
 * `data_tiering` - (Optional, Forces new resource) Enables data tiering. This option is not supported by all instance types. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html).
 * `description` - (Optional) Description for the cluster. Defaults to `"Managed by Terraform"`.
+* `engine` - (Optional) The engine that will run on your nodes. Supported values are `redis` and `valkey`.
+* `engine_version` - (Optional) Version number of the engine to be used for the cluster. Downgrades are not supported.
 * `final_snapshot_name` - (Optional) Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
 * `kms_key_arn` - (Optional, Forces new resource) ARN of the KMS key used to encrypt the cluster at rest.
 * `maintenance_window` - (Optional) Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:23:00-mon:01:30`.
diff --git a/website/docs/r/msk_replicator.html.markdown b/website/docs/r/msk_replicator.html.markdown
@@ -67,7 +67,7 @@ resource "aws_msk_replicator" "test" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `replicator_name` - (Required) The name of the replicator.
 * `kafka_cluster` - (Required) A list of Kafka clusters which are targets of the replicator.
diff --git a/website/docs/r/msk_vpc_connection.html.markdown b/website/docs/r/msk_vpc_connection.html.markdown
@@ -23,7 +23,7 @@ resource "aws_msk_vpc_connection" "test" {
 
 ## Argument Reference
 
-The following arguments are required:
+This resource supports the following arguments:
 
 * `authentication` - (Required) The authentication type for the client VPC connection. Specify one of these auth type strings: SASL_IAM, SASL_SCRAM, or TLS.
 * `client_subnets` - (Required) The list of subnets in the client VPC to connect to.
diff --git a/website/docs/r/mskconnect_custom_plugin.html.markdown b/website/docs/r/mskconnect_custom_plugin.html.markdown
diff --git a/website/docs/r/networkmonitor_probe.html.markdown b/website/docs/r/networkmonitor_probe.html.markdown
diff --git a/website/docs/r/quicksight_data_set.html.markdown b/website/docs/r/quicksight_data_set.html.markdown
diff --git a/website/docs/r/quicksight_role_membership.html.markdown b/website/docs/r/quicksight_role_membership.html.markdown
diff --git a/website/docs/r/route53profiles_resource_association.html.markdown b/website/docs/r/route53profiles_resource_association.html.markdown
diff --git a/website/docs/r/route53recoveryreadiness_recovery_group.html.markdown b/website/docs/r/route53recoveryreadiness_recovery_group.html.markdown
diff --git a/website/docs/r/s3control_bucket.html.markdown b/website/docs/r/s3control_bucket.html.markdown
diff --git a/website/docs/r/s3control_bucket_lifecycle_configuration.html.markdown b/website/docs/r/s3control_bucket_lifecycle_configuration.html.markdown
diff --git a/website/docs/r/securitylake_aws_log_source.html.markdown b/website/docs/r/securitylake_aws_log_source.html.markdown
diff --git a/website/docs/r/securitylake_data_lake.html.markdown b/website/docs/r/securitylake_data_lake.html.markdown
diff --git a/website/docs/r/securitylake_subscriber_notification.html.markdown b/website/docs/r/securitylake_subscriber_notification.html.markdown
diff --git a/website/docs/r/ssmincidents_response_plan.html.markdown b/website/docs/r/ssmincidents_response_plan.html.markdown
diff --git a/website/docs/r/vpclattice_target_group_attachment.html.markdown b/website/docs/r/vpclattice_target_group_attachment.html.markdown
