docs/provider: Change "mapping" to "map" (when referring to the data …

…structure) (#12908) The Terraform language supports maps (groups of key/value pairs) as a data type. These docs were generally referring to that data structure as a "mapping" instead, which is non-standard and was confusing some new users.
hashicorp · Apr 23, 2020 · cadc383 · cadc383
1 parent 6487feb
commit cadc383
Show file tree

Hide file tree

Showing 257 changed files with 270 additions and 270 deletions.
diff --git a/website/docs/d/api_gateway_api_key.html.markdown b/website/docs/d/api_gateway_api_key.html.markdown
@@ -32,4 +32,4 @@ data "aws_api_gateway_api_key" "my_api_key" {
  * `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 mapping of tags for the resource.
+ * `tags` - A map of tags for the resource.
diff --git a/website/docs/d/api_gateway_rest_api.html.markdown b/website/docs/d/api_gateway_rest_api.html.markdown
@@ -37,4 +37,4 @@ data "aws_api_gateway_rest_api" "my_rest_api" {
 * `minimum_compression_size` - Minimum response size to compress for the REST API.
 * `policy` - JSON formatted policy document that controls access to the API Gateway.
 * `root_resource_id` - Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.
-* `tags` - Key-value mapping of resource tags.
+* `tags` - Key-value map of resource tags.
diff --git a/website/docs/d/api_gateway_vpc_link.html.markdown b/website/docs/d/api_gateway_vpc_link.html.markdown
@@ -33,4 +33,4 @@ data "aws_api_gateway_vpc_link" "my_api_gateway_vpc_link" {
  * `status` - The status of the VPC link.
  * `status_message` - The status message of the VPC link.
  * `target_arns` - The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- * `tags` - Key-value mapping of resource tags
+ * `tags` - Key-value map of resource tags
diff --git a/website/docs/d/cloudwatch_log_group.html.markdown b/website/docs/d/cloudwatch_log_group.html.markdown
@@ -32,4 +32,4 @@ In addition to all arguments above, the following attributes are exported:
 * `creation_time` - The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 * `retention_in_days` - The number of days log events retained in the specified log group.
 * `kms_key_id` - The ARN of the KMS Key to use when encrypting log data.
-* `tags` - A mapping of tags to assign to the resource.
+* `tags` - A map of tags to assign to the resource.
diff --git a/website/docs/d/db_cluster_snapshot.html.markdown b/website/docs/d/db_cluster_snapshot.html.markdown
@@ -80,4 +80,4 @@ In addition to all arguments above, the following attributes are exported:
 * `status` - The status of this DB Cluster Snapshot.
 * `storage_encrypted` - Specifies whether the DB cluster snapshot is encrypted.
 * `vpc_id` - The VPC ID associated with the DB cluster snapshot.
-* `tags` - A mapping of tags for the resource.
+* `tags` - A map of tags for the resource.
diff --git a/website/docs/d/directory_service_directory.html.markdown b/website/docs/d/directory_service_directory.html.markdown
@@ -36,7 +36,7 @@ data "aws_directory_service_directory" "example" {
  * `access_url` - The access URL for the directory/connector, such as http://alias.awsapps.com.
  * `dns_ip_addresses` - A list of IP addresses of the DNS servers for the directory/connector.
  * `security_group_id` - The ID of the security group created by the directory/connector.
- * `tags` – A mapping of tags assigned to the directory/connector.
+ * `tags` – A map of tags assigned to the directory/connector.
 
  `vpc_settings` (for `SimpleAD` and `MicrosoftAD`) is also exported with the following attributes:
 

diff --git a/website/docs/d/ebs_snapshot.html.markdown b/website/docs/d/ebs_snapshot.html.markdown
@@ -61,6 +61,6 @@ In addition to all arguments above, the following attributes are exported:
 * `kms_key_id` - The ARN for the KMS encryption key.
 * `data_encryption_key_id` - The data encryption key identifier for the snapshot.
 * `state` - The snapshot state.
-* `tags` - A mapping of tags for the resource.
+* `tags` - A map of tags for the resource.
 
 [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-snapshots.html
diff --git a/website/docs/d/ebs_volume.html.markdown b/website/docs/d/ebs_volume.html.markdown
@@ -54,6 +54,6 @@ In addition to all arguments above, the following attributes are exported:
 * `snapshot_id` - The snapshot_id the EBS volume is based off.
 * `volume_type` - The type of EBS volume.
 * `kms_key_id` - The ARN for the KMS encryption key.
-* `tags` - A mapping of tags for the resource.
+* `tags` - A map of tags for the resource.
 
 [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-volumes.html
diff --git a/website/docs/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown b/website/docs/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown
@@ -28,7 +28,7 @@ The following arguments are supported:
 * `transit_gateway_id` - (Optional) Identifier of the EC2 Transit Gateway.
 * `dx_gateway_id` - (Optional) Identifier of the Direct Connect Gateway.
 * `filter` - (Optional) Configuration block(s) for filtering. Detailed below.
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match a pair on the desired Transit Gateway Direct Connect Gateway Attachment.
+* `tags` - (Optional) A map of tags, each pair of which must exactly match a pair on the desired Transit Gateway Direct Connect Gateway Attachment.
 
 ### filter Configuration Block
 

diff --git a/website/docs/d/ec2_transit_gateway_vpn_attachment.html.markdown b/website/docs/d/ec2_transit_gateway_vpn_attachment.html.markdown
@@ -39,7 +39,7 @@ The following arguments are supported:
 * `transit_gateway_id` - (Optional) Identifier of the EC2 Transit Gateway.
 * `vpn_connection_id` - (Optional) Identifier of the EC2 VPN Connection.
 * `filter` - (Optional) Configuration block(s) for filtering. Detailed below.
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match a pair on the desired Transit Gateway VPN Attachment.
+* `tags` - (Optional) A map of tags, each pair of which must exactly match a pair on the desired Transit Gateway VPN Attachment.
 
 ### filter Configuration Block
 

diff --git a/website/docs/d/ecr_repository.html.markdown b/website/docs/d/ecr_repository.html.markdown
@@ -31,4 +31,4 @@ In addition to all arguments above, the following attributes are exported:
 * `arn` - Full ARN of the repository.
 * `registry_id` - The registry ID where the repository was created.
 * `repository_url` - The URL of the repository (in the form `aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName`).
-* `tags` - A mapping of tags assigned to the resource.
+* `tags` - A map of tags assigned to the resource.
diff --git a/website/docs/d/efs_file_system.html.markdown b/website/docs/d/efs_file_system.html.markdown
@@ -41,5 +41,5 @@ In addition to all arguments above, the following attributes are exported:
 * `lifecycle_policy` - A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object.
 * `performance_mode` - The file system performance mode.
 * `provisioned_throughput_in_mibps` - The throughput, measured in MiB/s, that you want to provision for the file system.
-* `tags` -A mapping of tags to assign to the file system.
+* `tags` -A map of tags to assign to the file system.
 * `throughput_mode` - Throughput mode for the file system.
diff --git a/website/docs/d/eip.html.markdown b/website/docs/d/eip.html.markdown
@@ -58,7 +58,7 @@ Elastic IP whose data will be exported as attributes.
 * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html).
 * `id` - (Optional) The allocation id of the specific VPC EIP to retrieve. If a classic EIP is required, do NOT set `id`, only set `public_ip`
 * `public_ip` - (Optional) The public IP of the specific EIP to retrieve.
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match a pair on the desired Elastic IP
+* `tags` - (Optional) A map of tags, each pair of which must exactly match a pair on the desired Elastic IP
 
 ## Attributes Reference
 

diff --git a/website/docs/d/eks_cluster.html.markdown b/website/docs/d/eks_cluster.html.markdown
@@ -50,7 +50,7 @@ output "identity-oidc-issuer" {
 * `platform_version` - The platform version for the cluster.
 * `role_arn` - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
 * `status` - The status of the EKS cluster. One of `CREATING`, `ACTIVE`, `DELETING`, `FAILED`.
-* `tags` - Key-value mapping of resource tags.
+* `tags` - Key-value map of resource tags.
 * `version` - The Kubernetes server version for the cluster.
 * `vpc_config` - Nested list containing VPC configuration for the cluster.
   * `cluster_security_group_id` - The cluster security group that was created by Amazon EKS for the cluster. 

diff --git a/website/docs/d/instance.html.markdown b/website/docs/d/instance.html.markdown
@@ -33,7 +33,7 @@ data "aws_instance" "foo" {
 
 * `instance_id` - (Optional) Specify the exact Instance ID with which to populate the data source.
 
-* `instance_tags` - (Optional) A mapping of tags, each pair of which must
+* `instance_tags` - (Optional) A map of tags, each pair of which must
 exactly match a pair on the desired Instance.
 
 * `filter` - (Optional) One or more name/value pairs to use as filters. There are
@@ -108,7 +108,7 @@ interpolation.
 * `subnet_id` - The VPC subnet ID.
 * `user_data` - SHA-1 hash of User Data supplied to the Instance.
 * `user_data_base64` - Base64 encoded contents of User Data supplied to the Instance. Valid UTF-8 contents can be decoded with the [`base64decode` function](/docs/configuration/functions/base64decode.html). This attribute is only exported if `get_user_data` is true.
-* `tags` - A mapping of tags assigned to the Instance.
+* `tags` - A map of tags assigned to the Instance.
 * `tenancy` - The tenancy of the instance: `dedicated`, `default`, `host`.
 * `host_id` - The Id of the dedicated host the instance will be assigned to.
 * `vpc_security_group_ids` - The associated security groups in a non-default VPC.

diff --git a/website/docs/d/instances.html.markdown b/website/docs/d/instances.html.markdown
@@ -45,7 +45,7 @@ resource "aws_eip" "test" {
 
 ## Argument Reference
 
-* `instance_tags` - (Optional) A mapping of tags, each pair of which must
+* `instance_tags` - (Optional) A map of tags, each pair of which must
 exactly match a pair on desired instances.
 
 * `instance_state_names` - (Optional) A list of instance states that should be applicable to the desired instances. The permitted values are: `pending, running, shutting-down, stopped, stopping, terminated`. The default value is `running`.

diff --git a/website/docs/d/internet_gateway.html.markdown b/website/docs/d/internet_gateway.html.markdown
@@ -31,7 +31,7 @@ Internet Gateway whose data will be exported as attributes.
 
 * `internet_gateway_id` - (Optional) The id of the specific Internet Gateway to retrieve.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired Internet Gateway.
 
 * `filter` - (Optional) Custom filter block as described below.

diff --git a/website/docs/d/kinesis_stream.html.markdown b/website/docs/d/kinesis_stream.html.markdown
@@ -38,7 +38,7 @@ are exported:
 * `open_shards` - The list of shard ids in the OPEN state. See [Shard State][2] for more.
 * `closed_shards` - The list of shard ids in the CLOSED state. See [Shard State][2] for more.
 * `shard_level_metrics` - A list of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch][3] for more.
-* `tags` - A mapping of tags to assigned to the stream.
+* `tags` - A map of tags to assigned to the stream.
 
 [1]: https://aws.amazon.com/documentation/kinesis/
 [2]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing

diff --git a/website/docs/d/launch_template.html.markdown b/website/docs/d/launch_template.html.markdown
@@ -35,7 +35,7 @@ The following arguments are supported:
 
 * `filter` - (Optional) Configuration block(s) for filtering. Detailed below.
 * `name` - (Optional) The name of the launch template.
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match a pair on the desired Launch Template.
+* `tags` - (Optional) A map of tags, each pair of which must exactly match a pair on the desired Launch Template.
 
 ### filter Configuration Block
 
@@ -84,7 +84,7 @@ In addition to all arguments above, the following attributes are exported:
   `vpc_security_group_ids` instead.
 * `vpc_security_group_ids` - A list of security group IDs to associate with.
 * `tag_specifications` - The tags to apply to the resources during launch.
-* `tags` - (Optional) A mapping of tags to assign to the launch template.
+* `tags` - (Optional) A map of tags to assign to the launch template.
 * `user_data` - The Base64-encoded user data to provide when launching the instance.
 * `hibernation_options` - The hibernation options for the instance.
 
diff --git a/website/docs/d/nat_gateway.html.markdown b/website/docs/d/nat_gateway.html.markdown
@@ -42,7 +42,7 @@ Nat Gateway whose data will be exported as attributes.
 * `subnet_id` - (Optional) The id of subnet that the Nat Gateway resides in.
 * `vpc_id` - (Optional) The id of the VPC that the Nat Gateway resides in.
 * `state` - (Optional) The state of the NAT gateway (pending | failed | available | deleting | deleted ).
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired Nat Gateway.
 * `filter` - (Optional) Custom filter block as described below.
 

diff --git a/website/docs/d/network_acls.html.markdown b/website/docs/d/network_acls.html.markdown
@@ -53,7 +53,7 @@ data "aws_network_acls" "example" {
 
 * `vpc_id` - (Optional) The VPC ID that you want to filter from.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired network ACLs.
 
 * `filter` - (Optional) Custom filter block as described below.

diff --git a/website/docs/d/network_interfaces.html.markdown b/website/docs/d/network_interfaces.html.markdown
@@ -52,7 +52,7 @@ output "example" {
 
 ## Argument Reference
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired network interfaces.
 
 * `filter` - (Optional) Custom filter block as described below.

diff --git a/website/docs/d/route53_resolver_rule.html.markdown b/website/docs/d/route53_resolver_rule.html.markdown
@@ -41,4 +41,4 @@ In addition to all arguments above, the following attributes are exported:
 * `owner_id` - When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
 * `share_status` - Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
 Values are `NOT_SHARED`, `SHARED_BY_ME` or `SHARED_WITH_ME`
-* `tags` - A mapping of tags assigned to the resolver rule.
+* `tags` - A map of tags assigned to the resolver rule.
diff --git a/website/docs/d/route53_zone.html.markdown b/website/docs/d/route53_zone.html.markdown
@@ -43,7 +43,7 @@ Hosted Zone. If you use `name` field for private Hosted Zone, you need to add `p
 * `name` - (Optional) The Hosted Zone name of the desired Hosted Zone.
 * `private_zone` - (Optional) Used with `name` field to get a private Hosted Zone.
 * `vpc_id` - (Optional) Used with `name` field to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).
-* `tags` - (Optional) Used with `name` field. A mapping of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
+* `tags` - (Optional) Used with `name` field. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.
 
 ## Attributes Reference
 

diff --git a/website/docs/d/route_table.html.markdown b/website/docs/d/route_table.html.markdown
@@ -43,7 +43,7 @@ Route Table whose data will be exported as attributes.
 
 * `route_table_id` - (Optional) The id of the specific Route Table to retrieve.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired Route Table.
 
 * `vpc_id` - (Optional) The id of the VPC that the desired Route Table belongs to.

diff --git a/website/docs/d/route_tables.html.markdown b/website/docs/d/route_tables.html.markdown
@@ -40,7 +40,7 @@ resource "aws_route" "r" {
 
 * `vpc_id` - (Optional) The VPC ID that you want to filter from.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired route tables.
 
 More complex filters can be expressed using one or more `filter` sub-blocks,

diff --git a/website/docs/d/s3_bucket_object.html.markdown b/website/docs/d/s3_bucket_object.html.markdown
@@ -85,6 +85,6 @@ In addition to all arguments above, the following attributes are exported:
 * `storage_class` - [Storage class](http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) information of the object. Available for all objects except for `Standard` storage class objects.
 * `version_id` - The latest version ID of the object returned.
 * `website_redirect_location` - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
-* `tags`  - A mapping of tags assigned to the object.
+* `tags`  - A map of tags assigned to the object.
 
 -> **Note:** Terraform ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`.
diff --git a/website/docs/d/security_group.html.markdown b/website/docs/d/security_group.html.markdown
@@ -45,7 +45,7 @@ security group whose data will be exported as attributes.
 
 * `name` - (Optional) The name that the desired security group must have.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired security group.
 
 * `vpc_id` - (Optional) The id of the VPC that the desired security group belongs to.

diff --git a/website/docs/d/security_groups.html.markdown b/website/docs/d/security_groups.html.markdown
@@ -38,7 +38,7 @@ data "aws_security_groups" "test" {
 
 ## Argument Reference
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match for
+* `tags` - (Optional) A map of tags, each pair of which must exactly match for
 desired security groups.
 
 * `filter` - (Optional) One or more name/value pairs to use as filters. There are

diff --git a/website/docs/d/sqs_queue.html.markdown b/website/docs/d/sqs_queue.html.markdown
@@ -28,4 +28,4 @@ data "aws_sqs_queue" "example" {
 
 * `arn` - The Amazon Resource Name (ARN) of the queue.
 * `url` - The URL of the queue.
-* `tags` - A mapping of tags for the resource.
+* `tags` - A map of tags for the resource.
diff --git a/website/docs/d/subnet.html.markdown b/website/docs/d/subnet.html.markdown
@@ -63,7 +63,7 @@ subnet whose data will be exported as attributes.
 
 * `state` - (Optional) The state that the desired subnet must have.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired subnet.
 
 * `vpc_id` - (Optional) The id of the VPC that the desired subnet belongs to.

diff --git a/website/docs/d/subnet_ids.html.markdown b/website/docs/d/subnet_ids.html.markdown
@@ -58,7 +58,7 @@ resource "aws_instance" "app" {
 
 * `filter` - (Optional) Custom filter block as described below.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired subnets.
 
 More complex filters can be expressed using one or more `filter` sub-blocks,

diff --git a/website/docs/d/vpc.html.markdown b/website/docs/d/vpc.html.markdown
@@ -54,7 +54,7 @@ VPC whose data will be exported as attributes.
 * `state` - (Optional) The current state of the desired VPC.
   Can be either `"pending"` or `"available"`.
 
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the desired VPC.
 
 More complex filters can be expressed using one or more `filter` sub-blocks,

diff --git a/website/docs/d/vpc_dhcp_options.html.markdown b/website/docs/d/vpc_dhcp_options.html.markdown
@@ -57,5 +57,5 @@ For more information about filtering, see the [EC2 API documentation](https://do
 * `netbios_name_servers` - List of NETBIOS name servers.
 * `netbios_node_type` - The NetBIOS node type (1, 2, 4, or 8). For more information about these node types, see [RFC 2132](http://www.ietf.org/rfc/rfc2132.txt).
 * `ntp_servers` - List of NTP servers.
-* `tags` - A mapping of tags assigned to the resource.
+* `tags` - A map of tags assigned to the resource.
 * `owner_id` - The ID of the AWS account that owns the DHCP options set.
diff --git a/website/docs/d/vpc_endpoint.html.markdown b/website/docs/d/vpc_endpoint.html.markdown
@@ -35,7 +35,7 @@ The given filters must match exactly one VPC endpoint whose data will be exporte
 * `id` - (Optional) The ID of the specific VPC Endpoint to retrieve.
 * `service_name` - (Optional) The 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`).
 * `state` - (Optional) The state of the specific VPC Endpoint to retrieve.
-* `tags` - (Optional) A mapping of tags, each pair of which must exactly match
+* `tags` - (Optional) A map of tags, each pair of which must exactly match
   a pair on the specific VPC Endpoint to retrieve.
 * `vpc_id` - (Optional) The ID of the VPC in which the specific VPC Endpoint is used.