Skip to content

Commit 430ac37

Browse files
committed
Resources -- Standardize Argument Reference byline.
1 parent 61389e7 commit 430ac37

File tree

53 files changed

+134
-137
lines changed

Some content is hidden

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

53 files changed

+134
-137
lines changed

website/docs/r/autoscaling_policy.html.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ resource "aws_autoscaling_policy" "example" {
176176

177177
## Argument Reference
178178

179+
This resource supports the following arguments:
180+
179181
* `name` - (Required) Name of the policy.
180182
* `autoscaling_group_name` - (Required) Name of the autoscaling group.
181183
* `adjustment_type` - (Optional) Whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.

website/docs/r/budgets_budget.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,6 @@ resource "aws_budgets_budget" "cost" {
175175

176176
## Argument Reference
177177

178-
For more detailed documentation about each argument, refer to the [AWS official
179-
documentation](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/data-type-budget.html).
180-
181178
The following arguments are required:
182179

183180
* `budget_type` - (Required) Whether this budget tracks monetary cost or usage.
@@ -199,6 +196,9 @@ The following arguments are optional:
199196
* `time_period_end` - (Optional) The end of the time period covered by the budget. There are no restrictions on the end date. Format: `2017-01-01_12:00`.
200197
* `time_period_start` - (Optional) The start of the time period covered by the budget. If you don't specify a start date, AWS defaults to the start of your chosen time period. The start date must come before the end date. Format: `2017-01-01_12:00`.
201198

199+
For more detailed documentation about each argument, refer to the [AWS official
200+
documentation](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/data-type-budget.html).
201+
202202
## Attribute Reference
203203

204204
This resource exports the following attributes in addition to the arguments above:

website/docs/r/cloudwatch_event_target.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Provides an EventBridge Target resource.
1212

1313
~> **Note:** EventBridge was formerly known as CloudWatch Events. The functionality is identical.
1414

15+
-> **Note:** In order to be able to have your AWS Lambda function or
16+
SNS topic invoked by an EventBridge rule, you must set up the right permissions
17+
using [`aws_lambda_permission`](/docs/providers/aws/r/lambda_permission.html)
18+
or [`aws_sns_topic_policy`](/docs/providers/aws/r/sns_topic_policy.html).
19+
More info [here](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-use-resource-based.html).
20+
1521
## Example Usage
1622

1723
### Kinesis Usage
@@ -545,12 +551,6 @@ resource "aws_appsync_graphql_api" "graphql-api" {
545551

546552
## Argument Reference
547553

548-
-> **Note:** In order to be able to have your AWS Lambda function or
549-
SNS topic invoked by an EventBridge rule, you must set up the right permissions
550-
using [`aws_lambda_permission`](/docs/providers/aws/r/lambda_permission.html)
551-
or [`aws_sns_topic_policy`](/docs/providers/aws/r/sns_topic_policy.html).
552-
More info [here](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-use-resource-based.html).
553-
554554
The following arguments are required:
555555

556556
* `arn` - (Required) The Amazon Resource Name (ARN) of the target.

website/docs/r/cloudwatch_metric_alarm.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,6 @@ You must choose one or the other
171171

172172
## Argument Reference
173173

174-
See [related part of AWS Docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html)
175-
for details about valid values.
176-
177174
This resource supports the following arguments:
178175

179176
* `alarm_name` - (Required) The descriptive name for the alarm. This name must be unique within the user's AWS account
@@ -206,6 +203,9 @@ The following values are supported: `ignore`, and `evaluate`.
206203
* `metric_query` (Optional) Enables you to create an alarm based on a metric math expression. You may specify at most 20.
207204
* `tags` - (Optional) A map of tags to assign to the resource. 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.
208205

206+
See [related part of AWS Docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html)
207+
for details about valid values.
208+
209209
~> **NOTE:** If you specify at least one `metric_query`, you may not specify a `metric_name`, `namespace`, `period` or `statistic`. If you do not specify a `metric_query`, you must specify each of these (although you may use `extended_statistic` instead of `statistic`).
210210

211211
### Nested fields

website/docs/r/cognito_user_pool.html.markdown

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,9 @@ resource "aws_cognito_user_pool" "test" {
6363

6464
## Argument Reference
6565

66-
The following argument is required:
66+
This resource supports the following arguments:
6767

6868
* `name` - (Required) Name of the user pool.
69-
70-
The following arguments are optional:
71-
7269
* `account_recovery_setting` - (Optional) Configuration block to define which verified available method a user can use to recover their forgotten password. [Detailed below](#account_recovery_setting).
7370
* `admin_create_user_config` - (Optional) Configuration block for creating a new user profile. [Detailed below](#admin_create_user_config).
7471
* `alias_attributes` - (Optional) Attributes supported as an alias for this user pool. Valid values: `phone_number`, `email`, or `preferred_username`. Conflicts with `username_attributes`.

website/docs/r/config_conformance_pack.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,6 @@ EOT
8080

8181
## Argument Reference
8282

83-
~> **Note:** If both `template_body` and `template_s3_uri` are specified, AWS Config uses the `template_s3_uri` and ignores the `template_body`.
84-
8583
This resource supports the following arguments:
8684

8785
* `name` - (Required, Forces new resource) The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens.
@@ -91,6 +89,8 @@ This resource supports the following arguments:
9189
* `template_body` - (Optional, required if `template_s3_uri` is not provided) A string containing full conformance pack template body. Maximum length of 51200. Drift detection is not possible with this argument.
9290
* `template_s3_uri` - (Optional, required if `template_body` is not provided) Location of file, e.g., `s3://bucketname/prefix`, containing the template body. The uri must point to the conformance pack template that is located in an Amazon S3 bucket in the same region as the conformance pack. Maximum length of 1024. Drift detection is not possible with this argument.
9391

92+
~> **Note:** If both `template_body` and `template_s3_uri` are specified, AWS Config uses the `template_s3_uri` and ignores the `template_body`.
93+
9494
### input_parameter Argument Reference
9595

9696
The `input_parameter` configuration block supports the following arguments:

website/docs/r/controltower_control.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ resource "aws_controltower_control" "example" {
3838

3939
## Argument Reference
4040

41-
This following arguments are required:
41+
The following arguments are required:
4242

4343
* `control_identifier` - (Required) The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail.
4444
* `target_identifier` - (Required) The ARN of the organizational unit.

website/docs/r/db_instance.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,9 +276,6 @@ resource "aws_db_instance" "default" {
276276

277277
## Argument Reference
278278

279-
For more detailed documentation about each argument, refer to the [AWS official
280-
documentation](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).
281-
282279
This resource supports the following arguments:
283280

284281
* `allocated_storage` - (Required unless a `snapshot_identifier` or `replicate_source_db` is provided) The allocated storage in gibibytes. If `max_allocated_storage` is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If `replicate_source_db` is set, the value is ignored during the creation of the instance.
@@ -427,6 +424,9 @@ is provided) Username for the master DB user. Cannot be specified for a replica.
427424
associate.
428425
* `customer_owned_ip_enabled` - (Optional) Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See [CoIP for RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.coip) for more information.
429426

427+
For more detailed documentation about each argument, refer to the [AWS official
428+
documentation](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).
429+
430430
~> **NOTE:** Removing the `replicate_source_db` attribute from an existing RDS
431431
Replicate database managed by Terraform will promote the database to a fully
432432
standalone database.

website/docs/r/default_subnet.html.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ resource "aws_default_subnet" "default_az1" {
3131

3232
## Argument Reference
3333

34+
This resource supports the following arguments:
35+
3436
The arguments of an `aws_default_subnet` differ slightly from those of [`aws_subnet`](subnet.html):
3537

3638
* `availability_zone` is required

website/docs/r/default_vpc.html.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ resource "aws_default_vpc" "default" {
3434

3535
## Argument Reference
3636

37+
This resource supports the following arguments:
38+
3739
The arguments of an `aws_default_vpc` differ slightly from those of [`aws_vpc`](vpc.html):
3840

3941
* The `cidr_block` and `instance_tenancy` arguments become computed attributes

0 commit comments

Comments
 (0)