Skip to content

Commit cdfc81d

Browse files
committed
docs
1 parent 395cb66 commit cdfc81d

File tree

8 files changed

+15
-17
lines changed

8 files changed

+15
-17
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/kms/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ module "kms_key" {
7272
| <a name="input_allow_decrypt_for_arn"></a> [allow\_decrypt\_for\_arn](#input\_allow\_decrypt\_for\_arn) | Flag to allow generating a decrypt-only policy for specified ARNs. | `bool` | `false` | no |
7373
| <a name="input_allowed_arn"></a> [allowed\_arn](#input\_allowed\_arn) | List of ARNs that are allowed full encrypt/decrypt access to the KMS key. | `list(string)` | `[]` | no |
7474
| <a name="input_aws_identifiers"></a> [aws\_identifiers](#input\_aws\_identifiers) | List of ARNs that will be granted decrypt-only access. | `list(string)` | `[]` | no |
75-
| <a name="input_current_account_id"></a> [current\_account\_id](#input\_current\_account\_id) | n/a | `string` | n/a | yes |
75+
| <a name="input_current_account_id"></a> [current\_account\_id](#input\_current\_account\_id) | AWS account ID where the KMS key policy is applied. | `string` | n/a | yes |
7676
| <a name="input_environment"></a> [environment](#input\_environment) | Deployment environment (e.g., dev, staging, prod). | `string` | n/a | yes |
7777
| <a name="input_kms_key_description"></a> [kms\_key\_description](#input\_kms\_key\_description) | Description of the KMS key. | `string` | n/a | yes |
7878
| <a name="input_kms_key_name"></a> [kms\_key\_name](#input\_kms\_key\_name) | Name of the KMS key to be created. | `string` | n/a | yes |

infrastructure/modules/kms/variable.tf

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
variable "current_account_id" {
2-
type = string
2+
description = "AWS account ID where the KMS key policy is applied."
3+
type = string
34
}
45

56
variable "kms_key_name" {

infrastructure/modules/lambda/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ module "lambda" {
9292
| Name | Description | Type | Default | Required |
9393
|------|-------------|------|---------|:--------:|
9494
| <a name="input_api_execution_arn"></a> [api\_execution\_arn](#input\_api\_execution\_arn) | Execution ARN of the API Gateway used for granting invoke permissions. | `string` | n/a | yes |
95-
| <a name="input_default_policies"></a> [default\_policies](#input\_default\_policies) | n/a | `list` | <pre>[<br/> "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole",<br/> "arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy"<br/>]</pre> | no |
95+
| <a name="input_default_policies"></a> [default\_policies](#input\_default\_policies) | List of default IAM policy ARNs to attach to the Lambda execution role. | `list(string)` | <pre>[<br/> "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole",<br/> "arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy"<br/>]</pre> | no |
9696
| <a name="input_handler"></a> [handler](#input\_handler) | Function entry point in the codebase (e.g., 'index.handler'). | `string` | n/a | yes |
9797
| <a name="input_http_methods"></a> [http\_methods](#input\_http\_methods) | List of HTTP methods to integrate with the Lambda function. | `list(string)` | `[]` | no |
9898
| <a name="input_iam_role_policy_documents"></a> [iam\_role\_policy\_documents](#input\_iam\_role\_policy\_documents) | List of IAM policy document ARNs to attach to the Lambda execution role. | `list(string)` | `[]` | no |

infrastructure/modules/lambda/variable.tf

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,14 @@ variable "memory_size" {
7878
}
7979

8080
variable "reserved_concurrent_executions" {
81-
type = number
8281
description = "The number of concurrent execution allowed for lambda. A value of 0 will stop lambda from running, and -1 removes any concurrency limitations. Default to -1."
82+
type = number
8383
default = -1
8484
}
8585

8686
variable "default_policies" {
87+
description = "List of default IAM policy ARNs to attach to the Lambda execution role."
88+
type = list(string)
8789
default = [
8890
"arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole",
8991
"arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy"

infrastructure/modules/lambda_layers/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ module "lambda_layer" {
4646
|------|-------------|------|---------|:--------:|
4747
| <a name="input_account_id"></a> [account\_id](#input\_account\_id) | The AWS account ID used to generate IAM policy for layer access. | `string` | n/a | yes |
4848
| <a name="input_layer_name"></a> [layer\_name](#input\_layer\_name) | Logical name assigned to the Lambda layer. | `string` | n/a | yes |
49-
| <a name="input_layer_zip_file_name"></a> [layer\_zip\_file\_name](#input\_layer\_zip\_file\_name) | Path to the ZIP archive containing layer content. Defaults to a placeholder. | `string` | `"placeholder_lambda_payload.zip"` | no |
5049
## Outputs
5150

5251
| Name | Description |

infrastructure/modules/lambda_layers/variable.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@ variable "account_id" {
33
type = string
44
}
55

6-
variable "layer_zip_file_name" {
7-
description = "Path to the ZIP archive containing layer content. Defaults to a placeholder."
8-
type = string
9-
default = "placeholder_lambda_payload.zip"
10-
}
11-
126
variable "layer_name" {
137
description = "Logical name assigned to the Lambda layer."
148
type = string

infrastructure/variable.tf

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,15 @@ variable "cloudfront_edge_table_name" {
9090
}
9191

9292
variable "zip_store_dynamodb_table_name" {
93-
type = string
94-
default = "ZipStoreReferenceMetadata"
93+
description = "The name of the dynamodb table to store metadata related to zip file storage."
94+
type = string
95+
default = "ZipStoreReferenceMetadata"
9596
}
9697

9798
variable "stitch_metadata_dynamodb_table_name" {
98-
type = string
99-
default = "LloydGeorgeStitchJobMetadata"
99+
description = "The name of the dynamodb table to store metadata related to LG stitching jobs ."
100+
type = string
101+
default = "LloydGeorgeStitchJobMetadata"
100102
}
101103

102104
variable "auth_state_dynamodb_table_name" {

0 commit comments

Comments
 (0)