Skip to content

Commit

Permalink
Fix typos in variables descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
aleks-fofanov committed May 21, 2020
1 parent 820ca23 commit bbf908a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions docs/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@
| db\_instance\_id | DB Instance Identifier | `string` | n/a | yes |
| db\_instance\_security\_group\_id | DB instance security group to add rules to. Rules will allow communication between Lambda and DB instance | `string` | `null` | no |
| db\_master\_password | DB Instance master password. The usage of this parameter is discouraged. Consider putting db password in SSM Parameter Store and passing its ARN to the module via `db_master_password_ssm_parameter_arn` parameter | `string` | `null` | no |
| db\_master\_password\_ssm\_param | Name of SSM Parameter that stores password for master user. This param takes precendence other `db_master_password` | `string` | `null` | no |
| db\_master\_password\_ssm\_param | Name of SSM Parameter that stores password for master user. This param takes precedence other `db_master_password` | `string` | `null` | no |
| db\_master\_password\_ssm\_param\_kms\_key | Identifier of KMS key used for encryption of SSM Parameter that stores password for master user | `string` | `null` | no |
| db\_name | Database name that should be created | `string` | n/a | yes |
| db\_user | Name of user that should be created and own (has all persmiison to) the provisioned database. If left empty, no user will be created | `string` | `null` | no |
| db\_user\_password | Password for the user that should be created and own (has all persmiison to) the provisioned database. Ignored if `db_user` is set to null | `string` | `null` | no |
| db\_user\_password\_ssm\_param | Name of SSM Parameter that stores password for provisioned user. This param takes precendence other `db_user_password` | `string` | `null` | no |
| db\_user | Name of user that should be created and own (has all permission to) the provisioned database. If left empty, no user will be created | `string` | `null` | no |
| db\_user\_password | Password for the user that should be created and own (has all permission to) the provisioned database. Ignored if `db_user` is set to null | `string` | `null` | no |
| db\_user\_password\_ssm\_param | Name of SSM Parameter that stores password for provisioned user. This param takes precedence other `db_user_password` | `string` | `null` | no |
| db\_user\_password\_ssm\_param\_kms\_key | Identifier of KMS key used for encryption of SSM Parameter that stores password for provisioned user | `string` | `null` | no |
| delimiter | Delimiter to be used between `namespace`, `name`, `stage` and `attributes` | `string` | `"-"` | no |
| enabled | Defines whether this module should create resources | `bool` | `true` | no |
| invoke | Defines whether lambda function should be invoked immediately after provisioning | `bool` | `true` | no |
| kms\_key | KMS key identifier. Acceptes the same format as KMS key data source (https://www.terraform.io/docs/providers/aws/d/kms_key.html). If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key. | `string` | `null` | no |
| kms\_key | KMS key identifier. Accepts the same format as KMS key data source (https://www.terraform.io/docs/providers/aws/d/kms_key.html). If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key. | `string` | `null` | no |
| logs\_kms\_key\_id | KMS Key Id for Lambda function logs ecnryption | `string` | `null` | no |
| logs\_retention\_days | Lambda function logs retentions in days | `number` | `null` | no |
| memory | Amount of memory in MB your Lambda Function can use at runtime | `number` | `256` | no |
Expand All @@ -42,7 +42,7 @@
| stage | Stage (e.g. `prod`, `dev`, `staging`) | `string` | `""` | no |
| tags | Additional tags (e.g. `map(`BusinessUnit`,`XYZ`)` | `map(string)` | `{}` | no |
| timeout | The amount of time your Lambda Function has to run in seconds | `number` | `30` | no |
| vpc\_config | VPC configuratiuon for Lambda function | <pre>object({<br> vpc_id = string<br> subnet_ids = list(string)<br> security_group_ids = list(string)<br> })</pre> | n/a | yes |
| vpc\_config | VPC configuration for Lambda function | <pre>object({<br> vpc_id = string<br> subnet_ids = list(string)<br> security_group_ids = list(string)<br> })</pre> | n/a | yes |

## Outputs

Expand Down
12 changes: 6 additions & 6 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ variable "vpc_config" {
subnet_ids = list(string)
security_group_ids = list(string)
})
description = "VPC configuratiuon for Lambda function"
description = "VPC configuration for Lambda function"
}

variable "kms_key" {
type = string
default = null
description = "KMS key identifier. Acceptes the same format as KMS key data source (https://www.terraform.io/docs/providers/aws/d/kms_key.html). If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key."
description = "KMS key identifier. Accepts the same format as KMS key data source (https://www.terraform.io/docs/providers/aws/d/kms_key.html). If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key."
}

variable "invoke" {
Expand Down Expand Up @@ -93,7 +93,7 @@ variable "db_instance_id" {
variable "db_master_password_ssm_param" {
type = string
default = null
description = "Name of SSM Parameter that stores password for master user. This param takes precendence other `db_master_password`"
description = "Name of SSM Parameter that stores password for master user. This param takes precedence other `db_master_password`"
}

variable "db_master_password_ssm_param_kms_key" {
Expand Down Expand Up @@ -121,14 +121,14 @@ variable "db_name" {

variable "db_user" {
type = string
description = "Name of user that should be created and own (has all persmiison to) the provisioned database. If left empty, no user will be created"
description = "Name of user that should be created and own (has all permission to) the provisioned database. If left empty, no user will be created"
default = null
}

variable "db_user_password_ssm_param" {
type = string
default = null
description = "Name of SSM Parameter that stores password for provisioned user. This param takes precendence other `db_user_password`"
description = "Name of SSM Parameter that stores password for provisioned user. This param takes precedence other `db_user_password`"
}

variable "db_user_password_ssm_param_kms_key" {
Expand All @@ -139,7 +139,7 @@ variable "db_user_password_ssm_param_kms_key" {

variable "db_user_password" {
type = string
description = "Password for the user that should be created and own (has all persmiison to) the provisioned database. Ignored if `db_user` is set to null"
description = "Password for the user that should be created and own (has all permission to) the provisioned database. Ignored if `db_user` is set to null"
default = null
}

Expand Down

0 comments on commit bbf908a

Please sign in to comment.