Skip to content

Commit 31d0265

Browse files
authored
Merge pull request #42689 from hashicorp/d-further-arguments-byline-standardization
Documentation: Additional `Argument Reference` section byline standardization
2 parents 4c72db3 + 430ac37 commit 31d0265

File tree

75 files changed

+170
-210
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+170
-210
lines changed

website/docs/d/apigatewayv2_api.html.markdown

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ data "aws_apigatewayv2_api" "example" {
2020

2121
## Argument Reference
2222

23-
The arguments of this data source act as filters for querying the available APIs in the current region.
24-
The given filters must match exactly one API whose data will be exported as attributes.
25-
2623
This data source supports the following arguments:
2724

2825
* `api_id` - (Required) API identifier.

website/docs/d/connect_contact_flow.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_contact_flow" "test" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `contact_flow_id` - (Optional) Returns information on a specific Contact Flow by contact flow id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Contact Flow by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_contact_flow_module.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_contact_flow_module" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_module_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `contact_flow_module_id` - (Optional) Returns information on a specific Contact Flow Module by contact flow module id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Contact Flow Module by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_module_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_hours_of_operation.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_hours_of_operation" "test" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `hours_of_operation_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `hours_of_operation_id` - (Optional) Returns information on a specific Hours of Operation by hours of operation id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Hours of Operation by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `hours_of_operation_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_instance.html.markdown

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,13 @@ data "aws_connect_instance" "foo" {
3030

3131
## Argument Reference
3232

33-
~> **NOTE:** One of either `instance_id` or `instance_alias` is required.
34-
3533
This data source supports the following arguments:
3634

3735
* `instance_id` - (Optional) Returns information on a specific connect instance by id
38-
3936
* `instance_alias` - (Optional) Returns information on a specific connect instance by alias
4037

38+
~> **NOTE:** One of either `instance_id` or `instance_alias` is required.
39+
4140
## Attribute Reference
4241

4342
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_queue.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_queue" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `queue_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `queue_id` - (Optional) Returns information on a specific Queue by Queue id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Queue by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `queue_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_quick_connect.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_quick_connect" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `quick_connect_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `quick_connect_id` - (Optional) Returns information on a specific Quick Connect by Quick Connect id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Quick Connect by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `quick_connect_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_routing_profile.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_routing_profile" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `routing_profile_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `instance_id` - Reference to the hosting Amazon Connect Instance
4038
* `name` - (Optional) Returns information on a specific Routing Profile by name
4139
* `routing_profile_id` - (Optional) Returns information on a specific Routing Profile by Routing Profile id
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `routing_profile_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_security_profile.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_security_profile" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `security_profile_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `security_profile_id` - (Optional) Returns information on a specific Security Profile by Security Profile id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Security Profile by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `security_profile_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_user.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_user" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `user_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4038
* `name` - (Optional) Returns information on a specific User by name
4139
* `user_id` - (Optional) Returns information on a specific User by User id
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `user_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_user_hierarchy_group.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_user_hierarchy_group" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `hierarchy_group_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `hierarchy_group_id` - (Optional) Returns information on a specific hierarchy group by hierarchy group id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific hierarchy group by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `hierarchy_group_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_vocabulary.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_vocabulary" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `vocabulary_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4038
* `name` - (Optional) Returns information on a specific Vocabulary by name
4139
* `vocabulary_id` - (Optional) Returns information on a specific Vocabulary by Vocabulary id
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `vocabulary_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/db_snapshot.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ resource "aws_db_instance" "dev" {
4747

4848
## Argument Reference
4949

50-
~> **NOTE:** One of either `db_instance_identifier` or `db_snapshot_identifier` is required.
51-
5250
This data source supports the following arguments:
5351

5452
* `most_recent` - (Optional) If more than one result is returned, use the most
@@ -66,6 +64,8 @@ copied or restored by any AWS account, otherwise set this value to false. The de
6664
* `tags` - (Optional) Mapping of tags, each pair of which must exactly match
6765
a pair on the desired DB snapshot.
6866

67+
~> **NOTE:** One of either `db_instance_identifier` or `db_snapshot_identifier` is required.
68+
6969
## Attribute Reference
7070

7171
This data source exports the following attributes in addition to the arguments above:

website/docs/d/ec2_coip_pool.html.markdown

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,10 @@ data "aws_ec2_coip_pool" "selected" {
2828

2929
## Argument Reference
3030

31-
The arguments of this data source act as filters for querying the available
32-
COIP Pools in the current region. The given filters must match exactly one
33-
COIP Pool whose data will be exported as attributes.
31+
This data source supports the following arguments:
3432

3533
* `local_gateway_route_table_id` - (Optional) Local Gateway Route Table Id assigned to desired COIP Pool
36-
3734
* `pool_id` - (Optional) ID of the specific COIP Pool to retrieve.
38-
3935
* `tags` - (Optional) Mapping of tags, each pair of which must exactly match
4036
a pair on the desired COIP Pool.
4137

@@ -44,7 +40,6 @@ which take the following arguments:
4440

4541
* `name` - (Required) Name of the field to filter by, as defined by
4642
[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCoipPools.html).
47-
4843
* `values` - (Required) Set of values that are accepted for the given field.
4944
A COIP Pool will be selected if any one of the given values matches.
5045

website/docs/d/instance.html.markdown

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,15 @@ data "aws_instance" "foo" {
3030

3131
## Argument Reference
3232

33-
* `instance_id` - (Optional) Specify the exact Instance ID with which to populate the data source.
33+
This data source supports the following arguments:
3434

35+
* `instance_id` - (Optional) Specify the exact Instance ID with which to populate the data source.
3536
* `instance_tags` - (Optional) Map of tags, each pair of which must
3637
exactly match a pair on the desired Instance.
37-
3838
* `filter` - (Optional) One or more name/value pairs to use as filters. There are
3939
several valid keys, for a full reference, check out
4040
[describe-instances in the AWS CLI reference][1].
41-
4241
* `get_password_data` - (Optional) If true, wait for password data to become available and retrieve it. Useful for getting the administrator password for instances running Microsoft Windows. The password data is exported to the `password_data` attribute. See [GetPasswordData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information.
43-
4442
* `get_user_data` - (Optional) Retrieve Base64 encoded User Data contents into the `user_data_base64` attribute. A SHA-1 hash of the User Data contents will always be present in the `user_data` attribute. Defaults to `false`.
4543

4644
~> **NOTE:** At least one of `filter`, `instance_tags`, or `instance_id` must be specified.

website/docs/d/internet_gateway.html.markdown

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,18 @@ data "aws_internet_gateway" "default" {
2525

2626
## Argument Reference
2727

28-
The arguments of this data source act as filters for querying the available
29-
Internet Gateway in the current region. The given filters must match exactly one
30-
Internet Gateway whose data will be exported as attributes.
28+
This data source supports the following arguments:
3129

3230
* `internet_gateway_id` - (Optional) ID of the specific Internet Gateway to retrieve.
33-
3431
* `tags` - (Optional) Map of tags, each pair of which must exactly match
3532
a pair on the desired Internet Gateway.
36-
3733
* `filter` - (Optional) Custom filter block as described below.
3834

3935
More complex filters can be expressed using one or more `filter` sub-blocks,
4036
which take the following arguments:
4137

4238
* `name` - (Required) Name of the field to filter by, as defined by
4339
[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html).
44-
4540
* `values` - (Required) Set of values that are accepted for the given field.
4641
An Internet Gateway will be selected if any one of the given values matches.
4742

website/docs/d/route_table.html.markdown

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ resource "aws_route" "route" {
3232

3333
## Argument Reference
3434

35-
The arguments of this data source act as filters for querying the available Route Table in the current region. The given filters must match exactly one Route Table whose data will be exported as attributes.
36-
37-
The following arguments are optional:
35+
This data source supports the following arguments:
3836

3937
* `filter` - (Optional) Configuration block. Detailed below.
4038
* `gateway_id` - (Optional) ID of an Internet Gateway or Virtual Private Gateway which is connected to the Route Table (not exported if not passed as a parameter).

website/docs/d/security_group.html.markdown

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,27 +34,20 @@ resource "aws_subnet" "subnet" {
3434

3535
## Argument Reference
3636

37-
The arguments of this data source act as filters for querying the available
38-
security group in the current region. The given filters must match exactly one
39-
security group whose data will be exported as attributes.
37+
This data source supports the following arguments:
4038

4139
* `filter` - (Optional) Custom filter block as described below.
42-
4340
* `id` - (Optional) Id of the specific security group to retrieve.
44-
4541
* `name` - (Optional) Name that the desired security group must have.
46-
4742
* `tags` - (Optional) Map of tags, each pair of which must exactly match
4843
a pair on the desired security group.
49-
5044
* `vpc_id` - (Optional) Id of the VPC that the desired security group belongs to.
5145

5246
More complex filters can be expressed using one or more `filter` sub-blocks,
5347
which take the following arguments:
5448

5549
* `name` - (Required) Name of the field to filter by, as defined by
5650
[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html).
57-
5851
* `values` - (Required) Set of values that are accepted for the given field.
5952
A Security Group will be selected if any one of the given values matches.
6053

website/docs/d/shield_protection.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ data "aws_shield_protection" "example" {
3030

3131
## Argument Reference
3232

33-
~> Exactly one of `protection_id` or `resource_arn` is required.
34-
35-
The following arguments are optional:
33+
This data source supports the following arguments:
3634

3735
* `protection_id` - (Optional) Unique identifier for the protection.
3836
* `resource_arn` - (Optional) ARN (Amazon Resource Name) of the resource being protected.
3937

38+
~> Exactly one of `protection_id` or `resource_arn` is required.
39+
4040
## Attribute Reference
4141

4242
This data source exports the following attributes in addition to the arguments above:

website/docs/d/subnet.html.markdown

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@ data "aws_subnet" "selected" {
5050

5151
## Argument Reference
5252

53-
The arguments of this data source act as filters for querying the available subnets in the current region. The given filters must match exactly one subnet whose data will be exported as attributes.
54-
55-
The following arguments are optional:
53+
This data source supports the following arguments:
5654

5755
* `availability_zone` - (Optional) Availability zone where the subnet must reside.
5856
* `availability_zone_id` - (Optional) ID of the Availability Zone for the subnet. This argument is not supported in all regions or partitions. If necessary, use `availability_zone` instead.

website/docs/d/vpc.html.markdown

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,16 @@ resource "aws_subnet" "example" {
3636

3737
## Argument Reference
3838

39-
The arguments of this data source act as filters for querying the available
40-
VPCs in the current region. The given filters must match exactly one
41-
VPC whose data will be exported as attributes.
39+
This data source supports the following arguments:
4240

4341
* `cidr_block` - (Optional) Cidr block of the desired VPC.
44-
4542
* `dhcp_options_id` - (Optional) DHCP options id of the desired VPC.
46-
4743
* `default` - (Optional) Boolean constraint on whether the desired VPC is
4844
the default VPC for the region.
49-
5045
* `filter` - (Optional) Custom filter block as described below.
51-
5246
* `id` - (Optional) ID of the specific VPC to retrieve.
53-
5447
* `state` - (Optional) Current state of the desired VPC.
5548
Can be either `"pending"` or `"available"`.
56-
5749
* `tags` - (Optional) Map of tags, each pair of which must exactly match
5850
a pair on the desired VPC.
5951

@@ -62,7 +54,6 @@ which take the following arguments:
6254

6355
* `name` - (Required) Name of the field to filter by, as defined by
6456
[the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html).
65-
6657
* `values` - (Required) Set of values that are accepted for the given field.
6758
A VPC will be selected if any one of the given values matches.
6859

website/docs/d/vpc_endpoint_service.html.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ data "aws_vpc_endpoint_service" "test" {
5555

5656
## Argument Reference
5757

58-
The arguments of this data source act as filters for querying the available VPC endpoint services.
59-
The given filters must match exactly one VPC endpoint service whose data will be exported as attributes.
58+
This data source supports the following arguments:
6059

6160
* `filter` - (Optional) Configuration block(s) for filtering. Detailed below.
6261
* `service` - (Optional) Common name of an AWS service (e.g., `s3`).

0 commit comments

Comments
 (0)