Skip to content

Commit d83c97e

Browse files
SWhyteAnswerSWhyteAnswer
authored
[NDR-74] Variable Types & Descriptions (#351)
* docs * docs * [NDR-74] more descriptions and format changes * docs] * docs * docs * [NDR-74] sqs output descriptions * [NDR-74] api-env var desc * [NDR-74] re-adding vars * [NDR-74] typo fix --------- Co-authored-by: Sam Whyte <[email protected]>
1 parent 72e6a09 commit d83c97e

File tree

40 files changed

+616
-462
lines changed

40 files changed

+616
-462
lines changed

‎bootstrap/variables.tf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
variable "environment" {
2-
type = string
32
description = "Environment to bootstrap"
4-
}
3+
type = string
4+
}

‎infrastructure/modules/app_config/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ module "app_config" {
5555

5656
| Name | Description | Type | Default | Required |
5757
|------|-------------|------|---------|:--------:|
58-
| <a name="input_config_environment_name"></a> [config\_environment\_name](#input\_config\_environment\_name) | n/a | `string` | n/a | yes |
59-
| <a name="input_config_profile_name"></a> [config\_profile\_name](#input\_config\_profile\_name) | n/a | `string` | n/a | yes |
60-
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
61-
| <a name="input_owner"></a> [owner](#input\_owner) | n/a | `string` | n/a | yes |
58+
| <a name="input_config_environment_name"></a> [config\_environment\_name](#input\_config\_environment\_name) | Name of the AppConfig environment (e.g., dev, prod). | `string` | n/a | yes |
59+
| <a name="input_config_profile_name"></a> [config\_profile\_name](#input\_config\_profile\_name) | Name of the AppConfig configuration profile. | `string` | n/a | yes |
60+
| <a name="input_environment"></a> [environment](#input\_environment) | Deployment environment tag used for naming and labeling (e.g., dev, prod) | `string` | n/a | yes |
61+
| <a name="input_owner"></a> [owner](#input\_owner) | Identifies the team or person responsible for the resource (used for tagging). | `string` | n/a | yes |
6262
## Outputs
6363

6464
| Name | Description |

‎infrastructure/modules/app_config/variable.tf‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
variable "environment" {
2-
type = string
2+
description = "Deployment environment tag used for naming and labeling (e.g., dev, prod)"
3+
type = string
34
}
45

56
variable "owner" {
6-
type = string
7+
description = "Identifies the team or person responsible for the resource (used for tagging)."
8+
type = string
79
}
810

911
variable "config_environment_name" {
10-
type = string
12+
description = "Name of the AppConfig environment (e.g., dev, prod)."
13+
type = string
1114
}
1215

1316
variable "config_profile_name" {
14-
type = string
17+
description = "Name of the AppConfig configuration profile."
18+
type = string
1519
}
1620

1721

‎infrastructure/modules/cloudfront/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ module "cloudfront" {
4848

4949
| Name | Description | Type | Default | Required |
5050
|------|-------------|------|---------|:--------:|
51-
| <a name="input_bucket_domain_name"></a> [bucket\_domain\_name](#input\_bucket\_domain\_name) | Domain name to assign CloudFront distribution to | `string` | n/a | yes |
52-
| <a name="input_bucket_id"></a> [bucket\_id](#input\_bucket\_id) | Bucket ID to assign CloudFront distribution to | `string` | n/a | yes |
53-
| <a name="input_qualifed_arn"></a> [qualifed\_arn](#input\_qualifed\_arn) | Lambda@Edge function association | `string` | n/a | yes |
54-
| <a name="input_web_acl_id"></a> [web\_acl\_id](#input\_web\_acl\_id) | Web ACL to associate this Cloudfront distribution with | `string` | `""` | no |
51+
| <a name="input_bucket_domain_name"></a> [bucket\_domain\_name](#input\_bucket\_domain\_name) | Domain name to assign CloudFront distribution to. | `string` | n/a | yes |
52+
| <a name="input_bucket_id"></a> [bucket\_id](#input\_bucket\_id) | Bucket ID to assign CloudFront distribution to. | `string` | n/a | yes |
53+
| <a name="input_qualifed_arn"></a> [qualifed\_arn](#input\_qualifed\_arn) | Lambda@Edge function association. | `string` | n/a | yes |
54+
| <a name="input_web_acl_id"></a> [web\_acl\_id](#input\_web\_acl\_id) | Web ACL to associate this CloudFront distribution with. | `string` | `""` | no |
5555
## Outputs
5656

5757
| Name | Description |

‎infrastructure/modules/cloudfront/variable.tf‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
variable "bucket_domain_name" {
2+
description = "Domain name to assign CloudFront distribution to."
23
type = string
3-
description = "Domain name to assign CloudFront distribution to"
44
}
55

66
variable "bucket_id" {
7+
description = "Bucket ID to assign CloudFront distribution to."
78
type = string
8-
description = "Bucket ID to assign CloudFront distribution to"
99
}
1010

1111
variable "qualifed_arn" {
12+
description = "Lambda@Edge function association."
1213
type = string
13-
description = "Lambda@Edge function association"
1414
}
1515

1616
variable "web_acl_id" {
17+
description = "Web ACL to associate this CloudFront distribution with."
1718
type = string
18-
description = "Web ACL to associate this Cloudfront distribution with"
1919
default = ""
2020
}
2121

‎infrastructure/modules/dynamo_db/README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -96,20 +96,20 @@ module "document_reference_dynamodb_table" {
9696

9797
| Name | Description | Type | Default | Required |
9898
|------|-------------|------|---------|:--------:|
99-
| <a name="input_attributes"></a> [attributes](#input\_attributes) | List of nested attribute definitions | `list(map(string))` | `[]` | no |
100-
| <a name="input_billing_mode"></a> [billing\_mode](#input\_billing\_mode) | n/a | `string` | `"PAY_PER_REQUEST"` | no |
101-
| <a name="input_deletion_protection_enabled"></a> [deletion\_protection\_enabled](#input\_deletion\_protection\_enabled) | n/a | `bool` | `null` | no |
102-
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
103-
| <a name="input_global_secondary_indexes"></a> [global\_secondary\_indexes](#input\_global\_secondary\_indexes) | n/a | `any` | `[]` | no |
104-
| <a name="input_hash_key"></a> [hash\_key](#input\_hash\_key) | n/a | `string` | `null` | no |
105-
| <a name="input_owner"></a> [owner](#input\_owner) | n/a | `string` | n/a | yes |
106-
| <a name="input_point_in_time_recovery_enabled"></a> [point\_in\_time\_recovery\_enabled](#input\_point\_in\_time\_recovery\_enabled) | n/a | `bool` | `false` | no |
107-
| <a name="input_sort_key"></a> [sort\_key](#input\_sort\_key) | n/a | `string` | `null` | no |
108-
| <a name="input_stream_enabled"></a> [stream\_enabled](#input\_stream\_enabled) | n/a | `bool` | `false` | no |
109-
| <a name="input_stream_view_type"></a> [stream\_view\_type](#input\_stream\_view\_type) | n/a | `string` | `"NEW_AND_OLD_IMAGES"` | no |
110-
| <a name="input_table_name"></a> [table\_name](#input\_table\_name) | Name of the DynamoDB table | `string` | `null` | no |
111-
| <a name="input_ttl_attribute_name"></a> [ttl\_attribute\_name](#input\_ttl\_attribute\_name) | n/a | `string` | `""` | no |
112-
| <a name="input_ttl_enabled"></a> [ttl\_enabled](#input\_ttl\_enabled) | n/a | `bool` | `false` | no |
99+
| <a name="input_attributes"></a> [attributes](#input\_attributes) | List of nested attribute definitions. | `list(map(string))` | `[]` | no |
100+
| <a name="input_billing_mode"></a> [billing\_mode](#input\_billing\_mode) | DynamoDB billing mode (e.g., PAY\_PER\_REQUEST). | `string` | `"PAY_PER_REQUEST"` | no |
101+
| <a name="input_deletion_protection_enabled"></a> [deletion\_protection\_enabled](#input\_deletion\_protection\_enabled) | Prevents table from accidental deletion. | `bool` | `null` | no |
102+
| <a name="input_environment"></a> [environment](#input\_environment) | Deployment environment tag used for naming and labeling (e.g., dev, prod). | `string` | n/a | yes |
103+
| <a name="input_global_secondary_indexes"></a> [global\_secondary\_indexes](#input\_global\_secondary\_indexes) | List of optional Global Secondary Indexes. | `any` | `[]` | no |
104+
| <a name="input_hash_key"></a> [hash\_key](#input\_hash\_key) | Primary partition key for the table. | `string` | `null` | no |
105+
| <a name="input_owner"></a> [owner](#input\_owner) | Identifies the team or person responsible for the resource (used for tagging). | `string` | n/a | yes |
106+
| <a name="input_point_in_time_recovery_enabled"></a> [point\_in\_time\_recovery\_enabled](#input\_point\_in\_time\_recovery\_enabled) | Enables PITR for backups. | `bool` | `false` | no |
107+
| <a name="input_sort_key"></a> [sort\_key](#input\_sort\_key) | Optional sort key for composite primary key. | `string` | `null` | no |
108+
| <a name="input_stream_enabled"></a> [stream\_enabled](#input\_stream\_enabled) | Whether DynamoDB Streams are enabled. | `bool` | `false` | no |
109+
| <a name="input_stream_view_type"></a> [stream\_view\_type](#input\_stream\_view\_type) | Type of stream view (e.g., OLD\_IMAGE). | `string` | `"NEW_AND_OLD_IMAGES"` | no |
110+
| <a name="input_table_name"></a> [table\_name](#input\_table\_name) | Name of the DynamoDB table. | `string` | `null` | no |
111+
| <a name="input_ttl_attribute_name"></a> [ttl\_attribute\_name](#input\_ttl\_attribute\_name) | Name of the TTL attribute. | `string` | `""` | no |
112+
| <a name="input_ttl_enabled"></a> [ttl\_enabled](#input\_ttl\_enabled) | Whether to enable TTL (Time to Live) on items. | `bool` | `false` | no |
113113
## Outputs
114114

115115
| Name | Description |

‎infrastructure/modules/dynamo_db/variable.tf‎

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,81 @@
11
variable "table_name" {
2-
description = "Name of the DynamoDB table"
2+
description = "Name of the DynamoDB table."
33
type = string
44
default = null
55
}
66

77
variable "attributes" {
8-
description = "List of nested attribute definitions"
8+
description = "List of nested attribute definitions."
99
type = list(map(string))
1010
default = []
1111
}
1212

1313
variable "hash_key" {
14-
type = string
15-
default = null
14+
description = "Primary partition key for the table."
15+
type = string
16+
default = null
1617
}
1718

1819
variable "sort_key" {
19-
type = string
20-
default = null
20+
description = "Optional sort key for composite primary key."
21+
type = string
22+
default = null
2123
}
2224

2325
variable "billing_mode" {
24-
type = string
25-
default = "PAY_PER_REQUEST"
26+
description = "DynamoDB billing mode (e.g., PAY_PER_REQUEST)."
27+
type = string
28+
default = "PAY_PER_REQUEST"
2629
}
2730

2831
variable "ttl_enabled" {
29-
type = bool
30-
default = false
32+
description = "Whether to enable TTL (Time to Live) on items."
33+
type = bool
34+
default = false
3135
}
3236

3337
variable "ttl_attribute_name" {
34-
type = string
35-
default = ""
38+
description = "Name of the TTL attribute."
39+
type = string
40+
default = ""
3641
}
3742

3843
variable "global_secondary_indexes" {
39-
type = any
40-
default = []
44+
description = "List of optional Global Secondary Indexes."
45+
type = any
46+
default = []
4147
}
4248

4349
variable "deletion_protection_enabled" {
44-
type = bool
45-
default = null
50+
description = "Prevents table from accidental deletion."
51+
type = bool
52+
default = null
4653
}
4754

4855
variable "stream_enabled" {
49-
type = bool
50-
default = false
56+
description = "Whether DynamoDB Streams are enabled."
57+
type = bool
58+
default = false
5159
}
5260

5361
variable "stream_view_type" {
54-
type = string
55-
default = "NEW_AND_OLD_IMAGES"
62+
description = "Type of stream view (e.g., OLD_IMAGE)."
63+
type = string
64+
default = "NEW_AND_OLD_IMAGES"
5665
}
5766

5867
variable "environment" {
59-
type = string
68+
description = "Deployment environment tag used for naming and labeling (e.g., dev, prod)."
69+
type = string
6070
}
6171

6272
variable "owner" {
63-
type = string
73+
description = "Identifies the team or person responsible for the resource (used for tagging)."
74+
type = string
6475
}
6576

6677
variable "point_in_time_recovery_enabled" {
67-
type = bool
68-
default = false
69-
}
78+
description = "Enables PITR for backups."
79+
type = bool
80+
default = false
81+
}

‎infrastructure/modules/ecr/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ module "ecr_repository" {
4949

5050
| Name | Description | Type | Default | Required |
5151
|------|-------------|------|---------|:--------:|
52-
| <a name="input_app_name"></a> [app\_name](#input\_app\_name) | the name of the app | `string` | n/a | yes |
53-
| <a name="input_current_account_id"></a> [current\_account\_id](#input\_current\_account\_id) | n/a | `string` | n/a | yes |
54-
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
55-
| <a name="input_owner"></a> [owner](#input\_owner) | n/a | `string` | n/a | yes |
52+
| <a name="input_app_name"></a> [app\_name](#input\_app\_name) | Name of the application (used in repository naming). | `string` | n/a | yes |
53+
| <a name="input_current_account_id"></a> [current\_account\_id](#input\_current\_account\_id) | AWS account ID where the repository is created. | `string` | n/a | yes |
54+
| <a name="input_environment"></a> [environment](#input\_environment) | Deployment environment tag used for naming and labeling (e.g., dev, prod). | `string` | n/a | yes |
55+
| <a name="input_owner"></a> [owner](#input\_owner) | Identifies the team or person responsible for the resource (used for tagging). | `string` | n/a | yes |
5656
## Outputs
5757

5858
| Name | Description |

‎infrastructure/modules/ecr/variable.tf‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
variable "app_name" {
2-
description = "the name of the app"
2+
description = " Name of the application (used in repository naming)."
33
type = string
44
}
55

66
variable "environment" {
7-
type = string
7+
description = "Deployment environment tag used for naming and labeling (e.g., dev, prod)."
8+
type = string
89
}
910

1011
variable "owner" {
11-
type = string
12+
description = "Identifies the team or person responsible for the resource (used for tagging)."
13+
type = string
1214
}
1315

1416
variable "current_account_id" {
15-
type = string
16-
}
17+
description = "AWS account ID where the repository is created."
18+
type = string
19+
}

0 commit comments

Comments
 (0)