Skip to content

Commit f771ff6

Browse files
authored
docs: tidy up optional identity schema (#44290)
Within the "import by identity" section of the documentation, some arguments use a mix of `-` and `*` for list items. This change normalizes everything to `*`, re-ordering arguments where automated linter fixes had previously broken lists into two parts. Also updates the AI agent guide to reflect the preferred convention.
1 parent 19042d3 commit f771ff6

File tree

58 files changed

+111
-120
lines changed

Some content is hidden

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

58 files changed

+111
-120
lines changed

docs/ai-agent-guides/parameterized-resource-identity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ resource "<resource-name>" "example" {
9494

9595
#### Optional
9696

97-
- `account_id` (String) AWS Account where this resource is managed.
98-
- `region` (String) Region where this resource is managed.
97+
* `account_id` (String) AWS Account where this resource is managed.
98+
* `region` (String) Region where this resource is managed.
9999
````
100100

101101
- The instructions for importing by `identity`, including the identity schema, should appear before instructions for import blocks with an `id` argument or importing via the CLI.

website/docs/r/appflow_connector_profile.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,8 +347,8 @@ resource "aws_appflow_connector_profile" "example" {
347347

348348
#### Optional
349349

350-
- `account_id` (String) AWS Account where this resource is managed.
351-
- `region` (String) Region where this resource is managed.
350+
* `account_id` (String) AWS Account where this resource is managed.
351+
* `region` (String) Region where this resource is managed.
352352

353353
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow Connector Profile using the connector profile `name`. For example:
354354

website/docs/r/appflow_flow.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -441,8 +441,8 @@ resource "aws_appflow_flow" "example" {
441441

442442
#### Optional
443443

444-
- `account_id` (String) AWS Account where this resource is managed.
445-
- `region` (String) Region where this resource is managed.
444+
* `account_id` (String) AWS Account where this resource is managed.
445+
* `region` (String) Region where this resource is managed.
446446

447447
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow flows using the `name`. For example:
448448

website/docs/r/cloudfront_key_value_store.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ resource "aws_cloudfront_key_value_store" "example" {
7070

7171
#### Optional
7272

73-
- `account_id` (String) AWS Account where this resource is managed.
73+
* `account_id` (String) AWS Account where this resource is managed.
7474

7575
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront Key Value Store using the `name`. For example:
7676

website/docs/r/cloudfrontkeyvaluestore_key.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ resource "aws_cloudfrontkeyvaluestore_key" "example" {
7171

7272
#### Optional
7373

74-
- `account_id` (String) AWS Account where this resource is managed.
74+
* `account_id` (String) AWS Account where this resource is managed.
7575

7676
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `key_value_store_arn` and 'key' separated by `,`. For example:
7777

website/docs/r/cloudwatch_event_rule.html.markdown

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,9 @@ resource "aws_cloudwatch_event_rule" "example" {
109109

110110
#### Optional
111111

112-
* `event_bus_name` (String) Name of the event bus. If omitted, `default` is used.
113-
114-
- `account_id` (String) AWS Account where this resource is managed.
115-
- `region` (String) Region where this resource is managed.
112+
* `account_id` (String) AWS Account where this resource is managed.
113+
* `event_bus_name` (String) Name of the event bus.
114+
* `region` (String) Region where this resource is managed.
116115

117116
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EventBridge Rules using the `event_bus_name/rule_name` (if you omit `event_bus_name`, the `default` event bus will be used). For example:
118117

website/docs/r/cloudwatch_event_target.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -717,8 +717,8 @@ resource "aws_cloudwatch_event_target" "example" {
717717

718718
#### Optional
719719

720-
- `account_id` (String) AWS Account where this resource is managed.
721-
- `region` (String) Region where this resource is managed.
720+
* `account_id` (String) AWS Account where this resource is managed.
721+
* `region` (String) Region where this resource is managed.
722722

723723
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EventBridge Targets using `event_bus_name/rule-name/target-id` (if you omit `event_bus_name`, the `default` event bus will be used). For example:
724724

website/docs/r/cloudwatch_log_group.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ resource "aws_cloudwatch_log_group" "example" {
7272

7373
#### Optional
7474

75-
- `account_id` (String) AWS Account where this resource is managed.
76-
- `region` (String) Region where this resource is managed.
75+
* `account_id` (String) AWS Account where this resource is managed.
76+
* `region` (String) Region where this resource is managed.
7777

7878
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Cloudwatch Log Groups using the `name`. For example:
7979

website/docs/r/cloudwatch_metric_alarm.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,8 @@ resource "aws_cloudwatch_metric_alarm" "example" {
272272

273273
#### Optional
274274

275-
- `account_id` (String) AWS Account where this resource is managed.
276-
- `region` (String) Region where this resource is managed.
275+
* `account_id` (String) AWS Account where this resource is managed.
276+
* `region` (String) Region where this resource is managed.
277277

278278
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudWatch Metric Alarm using the `alarm_name`. For example:
279279

website/docs/r/cognito_log_delivery_configuration.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,8 @@ resource "aws_cognito_log_delivery_configuration" "example" {
225225

226226
#### Optional
227227

228-
- `account_id` (String) AWS Account where this resource is managed.
229-
- `region` (String) Region where this resource is managed.
228+
* `account_id` (String) AWS Account where this resource is managed.
229+
* `region` (String) Region where this resource is managed.
230230

231231
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Cognito IDP (Identity Provider) Log Delivery Configuration using the `user_pool_id`. For example:
232232

0 commit comments

Comments
 (0)