Merge pull request #38147 from acwwat/d-fix_ref_wording

docs: Fix improper use of "argument" as ref to resources, data sources, and config blocks
hashicorp · Jun 27, 2024 · 01b084c · 01b084c
2 parents 02adf91 + b4aafc9
commit 01b084c
Show file tree

Hide file tree

Showing 45 changed files with 184 additions and 172 deletions.
diff --git a/website/docs/d/apigatewayv2_api.html.markdown b/website/docs/d/apigatewayv2_api.html.markdown
@@ -23,7 +23,7 @@ data "aws_apigatewayv2_api" "example" {
 The arguments of this data source act as filters for querying the available APIs in the current region.
 The given filters must match exactly one API whose data will be exported as attributes.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `api_id` - (Required) API identifier.
 

diff --git a/website/docs/d/connect_contact_flow.html.markdown b/website/docs/d/connect_contact_flow.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_contact_flow" "test" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `contact_flow_id` - (Optional) Returns information on a specific Contact Flow by contact flow id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_contact_flow_module.html.markdown b/website/docs/d/connect_contact_flow_module.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_contact_flow_module" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_module_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `contact_flow_module_id` - (Optional) Returns information on a specific Contact Flow Module by contact flow module id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_hours_of_operation.html.markdown b/website/docs/d/connect_hours_of_operation.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_hours_of_operation" "test" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `hours_of_operation_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `hours_of_operation_id` - (Optional) Returns information on a specific Hours of Operation by hours of operation id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_instance.html.markdown b/website/docs/d/connect_instance.html.markdown
@@ -32,7 +32,7 @@ data "aws_connect_instance" "foo" {
 
 ~> **NOTE:** One of either `instance_id` or `instance_alias` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `instance_id` - (Optional) Returns information on a specific connect instance by id
 

diff --git a/website/docs/d/connect_queue.html.markdown b/website/docs/d/connect_queue.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_queue" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `queue_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `queue_id` - (Optional) Returns information on a specific Queue by Queue id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_quick_connect.html.markdown b/website/docs/d/connect_quick_connect.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_quick_connect" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `quick_connect_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `quick_connect_id` - (Optional) Returns information on a specific Quick Connect by Quick Connect id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_routing_profile.html.markdown b/website/docs/d/connect_routing_profile.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_routing_profile" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `routing_profile_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `instance_id` - Reference to the hosting Amazon Connect Instance
 * `name` - (Optional) Returns information on a specific Routing Profile by name

diff --git a/website/docs/d/connect_security_profile.html.markdown b/website/docs/d/connect_security_profile.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_security_profile" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `security_profile_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `security_profile_id` - (Optional) Returns information on a specific Security Profile by Security Profile id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_user.html.markdown b/website/docs/d/connect_user.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_user" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `user_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
 * `name` - (Optional) Returns information on a specific User by name

diff --git a/website/docs/d/connect_user_hierarchy_group.html.markdown b/website/docs/d/connect_user_hierarchy_group.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_user_hierarchy_group" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `hierarchy_group_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `hierarchy_group_id` - (Optional) Returns information on a specific hierarchy group by hierarchy group id
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance

diff --git a/website/docs/d/connect_vocabulary.html.markdown b/website/docs/d/connect_vocabulary.html.markdown
@@ -34,7 +34,7 @@ data "aws_connect_vocabulary" "example" {
 
 ~> **NOTE:** `instance_id` and one of either `name` or `vocabulary_id` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
 * `name` - (Optional) Returns information on a specific Vocabulary by name

diff --git a/website/docs/d/db_snapshot.html.markdown b/website/docs/d/db_snapshot.html.markdown
@@ -49,7 +49,7 @@ resource "aws_db_instance" "dev" {
 
 ~> **NOTE:** One of either `db_instance_identifier` or `db_snapshot_identifier` is required.
 
-This argument supports the following arguments:
+This data source supports the following arguments:
 
 * `most_recent` - (Optional) If more than one result is returned, use the most
 recent Snapshot.

diff --git a/website/docs/d/service_discovery_service.html.markdown b/website/docs/d/service_discovery_service.html.markdown
@@ -33,37 +33,37 @@ This data source exports the following attributes in addition to the arguments a
 * `id` - ID of the service.
 * `arn` - ARN of the service.
 * `description` - Description of the service.
-* `dns_config` - Complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.
-* `health_check_config` - Complex type that contains settings for an optional health check. Only for Public DNS namespaces.
-* `health_check_custom_config` -  A complex type that contains settings for ECS managed health checks.
+* `dns_config` - Complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. See [`dns_config` Block](#dns_config-block) for details.
+* `health_check_config` - Complex type that contains settings for an optional health check. Only for Public DNS namespaces. See [`health_check_config` Block](#health_check_config-block) for details.
+* `health_check_custom_config` -  A complex type that contains settings for ECS managed health checks. See [`health_check_custom_config` Block](#health_check_custom_config-block) for details.
 * `tags` - Map of tags to assign to the service. 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.
 * `tags_all` - (**Deprecated**) Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block).
 
-### dns_config
+### `dns_config` Block
 
-This argument supports the following arguments:
+The `dns_config` configuration block supports the following arguments:
 
 * `namespace_id` - ID of the namespace to use for DNS configuration.
-* `dns_records` - An array that contains one DnsRecord object for each resource record set.
+* `dns_records` - An array that contains one DnsRecord object for each resource record set. See [`dns_records` Block](#dns_records-block) for details.
 * `routing_policy` - Routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify the service. Valid Values: MULTIVALUE, WEIGHTED
 
-#### dns_records
+#### `dns_records` Block
 
-This argument supports the following arguments:
+The `dns_records` configuration block supports the following arguments:
 
 * `ttl` - Amount of time, in seconds, that you want DNS resolvers to cache the settings for this resource record set.
 * `type` - Type of the resource, which indicates the value that Amazon Route 53 returns in response to DNS queries. Valid Values: A, AAAA, SRV, CNAME
 
-### health_check_config
+### `health_check_config` Block
 
-This argument supports the following arguments:
+The `health_check_config` configuration block supports the following arguments:
 
 * `failure_threshold` - Number of consecutive health checks. Maximum value of 10.
 * `resource_path` - Path that you want Route 53 to request when performing health checks. Route 53 automatically adds the DNS name for the service. If you don't specify a value, the default value is /.
 * `type` -  The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP
 
-### health_check_custom_config
+### `health_check_custom_config` Block
 
-This argument supports the following arguments:
+The `health_check_custom_config` configuration block supports the following arguments:
 
 * `failure_threshold` -  The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance.  Maximum value of 10.
diff --git a/website/docs/r/appsync_datasource.html.markdown b/website/docs/r/appsync_datasource.html.markdown
@@ -81,88 +81,90 @@ This resource supports the following arguments:
 * `name` - (Required) User-supplied name for the data source.
 * `type` - (Required) Type of the Data Source. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`, `RELATIONAL_DATABASE`, `AMAZON_EVENTBRIDGE`, `AMAZON_OPENSEARCH_SERVICE`.
 * `description` - (Optional) Description of the data source.
-* `dynamodb_config` - (Optional) DynamoDB settings. See [DynamoDB Config](#dynamodb-config)
-* `elasticsearch_config` - (Optional) Amazon Elasticsearch settings. See [ElasticSearch Config](#elasticsearch-config)
-* `event_bridge_config` - (Optional) AWS EventBridge settings. See [Event Bridge Config](#event-bridge-config)
-* `http_config` - (Optional) HTTP settings. See [HTTP Config](#http-config)
-* `lambda_config` - (Optional) AWS Lambda settings. See [Lambda Config](#lambda-config)
-* `opensearchservice_config` - (Optional) Amazon OpenSearch Service settings. See [OpenSearch Service Config](#opensearch-service-config)
-* `relational_database_config` (Optional) AWS RDS settings. See [Relational Database Config](#relational-database-config)
+* `dynamodb_config` - (Optional) DynamoDB settings. See [`dynamodb_config` Block](#dynamodb_config-block) for details.
+* `elasticsearch_config` - (Optional) Amazon Elasticsearch settings. See [`elasticsearch_config` Block](#elasticsearch_config-block) for details.
+* `event_bridge_config` - (Optional) AWS EventBridge settings. See [`event_bridge_config` Block](#event_bridge_config-block) for details.
+* `http_config` - (Optional) HTTP settings. See [`http_config` Block](#http_config-block) for details.
+* `lambda_config` - (Optional) AWS Lambda settings. See [`lambda_config` Block](#lambda_config-block) for details.
+* `opensearchservice_config` - (Optional) Amazon OpenSearch Service settings. See [`opensearchservice_config` Block](#opensearchservice_config-block) for details.
+* `relational_database_config` (Optional) AWS RDS settings. See [`relational_database_config` Block](#relational_database_config-block) for details.
 * `service_role_arn` - (Optional) IAM service role ARN for the data source. Required if `type` is specified as `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `AMAZON_EVENTBRIDGE`, or `AMAZON_OPENSEARCH_SERVICE`.
 
-### DynamoDB Config
+### `dynamodb_config` Block
 
-This argument supports the following arguments:
+The `dynamodb_config` configuration block supports the following arguments:
 
 * `table_name` - (Required) Name of the DynamoDB table.
 * `region` - (Optional) AWS region of the DynamoDB table. Defaults to current region.
 * `use_caller_credentials` - (Optional) Set to `true` to use Amazon Cognito credentials with this data source.
-* `delta_sync_config` - (Optional) The DeltaSyncConfig for a versioned data source. See [Delta Sync Config](#delta-sync-config)
+* `delta_sync_config` - (Optional) The DeltaSyncConfig for a versioned data source. See [`delta_sync_config` Block](#delta_sync_config-block) for details.
 * `versioned` - (Optional) Detects Conflict Detection and Resolution with this data source.
 
-### Delta Sync Config
+### `delta_sync_config` Block
+
+The `delta_sync_config` configuration block supports the following arguments:
 
 * `base_table_ttl` - (Optional) The number of minutes that an Item is stored in the data source.
 * `delta_sync_table_name` - (Required) The table name.
 * `delta_sync_table_ttl` - (Optional) The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
 
-### ElasticSearch Config
+### `elasticsearch_config` Block
 
-This argument supports the following arguments:
+The `elasticsearch_config` configuration block supports the following arguments:
 
 * `endpoint` - (Required) HTTP endpoint of the Elasticsearch domain.
 * `region` - (Optional) AWS region of Elasticsearch domain. Defaults to current region.
 
-### Event Bridge Config
+### `event_bridge_config` Block
 
-This argument supports the following arguments:
+The `event_bridge_config` configuration block supports the following arguments:
 
 * `event_bus_arn` - (Required) ARN for the EventBridge bus.
 
-### HTTP Config
+### `http_config` Block
 
-This argument supports the following arguments:
+The `http_config` configuration block supports the following arguments:
 
 * `endpoint` - (Required) HTTP URL.
-* `authorization_config` - (Optional) Authorization configuration in case the HTTP endpoint requires authorization. See [Authorization Config](#authorization-config).
+* `authorization_config` - (Optional) Authorization configuration in case the HTTP endpoint requires authorization. See [`authorization_config` Block](#authorization_config-block) for details.
 
-#### Authorization Config
+### `authorization_config` Block
 
-This argument supports the following arguments:
+The `authorization_config` configuration block supports the following arguments:
 
 * `authorization_type` - (Optional) Authorization type that the HTTP endpoint requires. Default values is `AWS_IAM`.
-* `aws_iam_config` - (Optional) Identity and Access Management (IAM) settings. See [AWS IAM Config](#aws-iam-config).
+* `aws_iam_config` - (Optional) Identity and Access Management (IAM) settings. See [`aws_iam_config` Block](#aws_iam_config-block) for details.
 
-##### AWS IAM Config
+### `aws_iam_config` Block
 
-This argument supports the following arguments:
+The `aws_iam_config` configuration block supports the following arguments:
 
 * `signing_region` - (Optional) Signing Amazon Web Services Region for IAM authorization.
 * `signing_service_name`- (Optional) Signing service name for IAM authorization.
 
-### Lambda Config
+### `lambda_config` Block
 
-This argument supports the following arguments:
+The `lambda_config` configuration block supports the following arguments:
 
 * `function_arn` - (Required) ARN for the Lambda function.
 
-### OpenSearch Service Config
+### `opensearchservice_config` Block
 
-This argument supports the following arguments:
+The `opensearchservice_config` configuration block supports the following arguments:
 
 * `endpoint` - (Required) HTTP endpoint of the OpenSearch domain.
 * `region` - (Optional) AWS region of the OpenSearch domain. Defaults to current region.
 
-### Relational Database Config
+### `relational_database_config` Block
 
-This argument supports the following arguments:
+The `relational_database_config` configuration block supports the following arguments:
 
-* `http_endpoint_config` - (Required) Amazon RDS HTTP endpoint configuration. See [HTTP Endpoint Config](#http-endpoint-config).
+* `http_endpoint_config` - (Required) Amazon RDS HTTP endpoint configuration. See [`http_endpoint_config` Block](#http_endpoint_config-block) for details.
 * `source_type` - (Optional) Source type for the relational database. Valid values: `RDS_HTTP_ENDPOINT`.
 
-#### HTTP Endpoint Config
+### `http_endpoint_config` Block
 
-This argument supports the following arguments:
+The `http_endpoint_config` configuration block supports the following arguments:
 
 * `db_cluster_identifier` - (Required) Amazon RDS cluster identifier.
 * `aws_secret_store_arn` - (Required) AWS secret store ARN for database credentials.

diff --git a/website/docs/r/appsync_function.html.markdown b/website/docs/r/appsync_function.html.markdown
@@ -100,28 +100,28 @@ This resource supports the following arguments:
 * `request_mapping_template` - (Optional) Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
 * `response_mapping_template` - (Optional) Function response mapping template.
 * `description` - (Optional) Function description.
-* `runtime` - (Optional) Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. See [Runtime](#runtime).
-* `sync_config` - (Optional) Describes a Sync configuration for a resolver. See [Sync Config](#sync-config).
+* `runtime` - (Optional) Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. See [`runtime` Block](#runtime-block) for details.
+* `sync_config` - (Optional) Describes a Sync configuration for a resolver. See [`sync_config` Block](#sync_config-block) for details.
 * `function_version` - (Optional) Version of the request mapping template. Currently the supported value is `2018-05-29`. Does not apply when specifying `code`.
 
-### Runtime
+### `runtime` Block
 
-This argument supports the following arguments:
+The `runtime` configuration block supports the following arguments:
 
 * `name` - (Optional) The name of the runtime to use. Currently, the only allowed value is `APPSYNC_JS`.
 * `runtime_version` - (Optional) The version of the runtime to use. Currently, the only allowed version is `1.0.0`.
 
-### Sync Config
+### `sync_config` Block
 
-This argument supports the following arguments:
+The `sync_config` configuration block supports the following arguments:
 
 * `conflict_detection` - (Optional) Conflict Detection strategy to use. Valid values are `NONE` and `VERSION`.
 * `conflict_handler` - (Optional) Conflict Resolution strategy to perform in the event of a conflict. Valid values are `NONE`, `OPTIMISTIC_CONCURRENCY`, `AUTOMERGE`, and `LAMBDA`.
-* `lambda_conflict_handler_config` - (Optional) Lambda Conflict Handler Config when configuring `LAMBDA` as the Conflict Handler. See [Lambda Conflict Handler Config](#lambda-conflict-handler-config).
+* `lambda_conflict_handler_config` - (Optional) Lambda Conflict Handler Config when configuring `LAMBDA` as the Conflict Handler. See [`lambda_conflict_handler_config` Block](#lambda_conflict_handler_config-block) for details.
 
-#### Lambda Conflict Handler Config
+#### `lambda_conflict_handler_config` Block
 
-This argument supports the following arguments:
+The `lambda_conflict_handler_config` configuration block supports the following arguments:
 
 * `lambda_conflict_handler_arn` - (Optional) ARN for the Lambda function to use as the Conflict Handler.