Skip to content

Commit 70328bc

Browse files
authored
Updated description of parameter function_name.
Value can be either a name or an ARN, it is also a required parameter. Slightly corrected grammar.
1 parent 1c3b16a commit 70328bc

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

modules/alias/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# AWS Lambda Alias
22

3-
Terraform module, which creates Lambda alias as well as takes care of async event configuration and Lambda permissions for alias.
3+
Terraform module, which creates a Lambda alias as well as takes care of async event configuration and Lambda permissions for the alias.
44

5-
Lambda Alias is required to do complex Lambda deployments, eg. using external tools like AWS CodeDeploy.
5+
Lambda Alias is required to do complex Lambda deployments, e.g., using external tools like AWS CodeDeploy.
66

7-
This Terraform module is the part of [serverless.tf framework](https://github.com/antonbabenko/serverless.tf), which aims to simplify all operations when working with the serverless in Terraform.
7+
This Terraform module is part of [serverless.tf framework](https://github.com/antonbabenko/serverless.tf), which aims to simplify all operations when working with serverless in Terraform.
88

99

1010
## Usage
1111

12-
### Lambda Function and statically configured alias with the version of Lambda Function
12+
### Lambda Function and statically configured alias with the version of the Lambda Function
1313

1414
```hcl
1515
module "lambda_function" {
@@ -43,7 +43,7 @@ module "alias_no_refresh" {
4343

4444
### Lambda Alias (auto-refreshing when version changed externally)
4545

46-
This is useful when doing complex deployments using external tool.
46+
This is useful when doing complex deployments using an external tool.
4747

4848
```hcl
4949
module "alias_refresh" {
@@ -56,7 +56,7 @@ module "alias_refresh" {
5656

5757
### Lambda Alias (using existing alias)
5858

59-
This is useful when extra configuration on existing Lambda alias is required.
59+
This is useful when extra configuration on the existing Lambda alias is required.
6060

6161
```hcl
6262
module "alias_refresh" {
@@ -86,7 +86,7 @@ module "alias_existing" {
8686

8787
## Conditional creation
8888

89-
Sometimes you need to have a way to create resources conditionally but Terraform does not allow usage of `count` inside `module` block, so the solution is to specify `create` arguments.
89+
Sometimes you need to have a way to create resources conditionally, but Terraform does not allow the usage of `count` inside `module` block, so the solution is to specify `create` arguments.
9090

9191
```hcl
9292
module "lambda" {
@@ -155,7 +155,7 @@ No modules.
155155
| <a name="input_destination_on_failure"></a> [destination\_on\_failure](#input\_destination\_on\_failure) | Amazon Resource Name (ARN) of the destination resource for failed asynchronous invocations | `string` | `null` | no |
156156
| <a name="input_destination_on_success"></a> [destination\_on\_success](#input\_destination\_on\_success) | Amazon Resource Name (ARN) of the destination resource for successful asynchronous invocations | `string` | `null` | no |
157157
| <a name="input_event_source_mapping"></a> [event\_source\_mapping](#input\_event\_source\_mapping) | Map of event source mapping | `any` | `{}` | no |
158-
| <a name="input_function_name"></a> [function\_name](#input\_function\_name) | The function ARN of the Lambda function for which you want to create an alias. | `string` | `""` | no |
158+
| <a name="input_function_name"></a> [function\_name](#input\_function\_name) | Name or ARN of the Lambda function for which you want to create an alias. | `string` | `""` | yes |
159159
| <a name="input_function_version"></a> [function\_version](#input\_function\_version) | Lambda function version for which you are creating the alias. Pattern: ($LATEST\|[0-9]+). | `string` | `""` | no |
160160
| <a name="input_maximum_event_age_in_seconds"></a> [maximum\_event\_age\_in\_seconds](#input\_maximum\_event\_age\_in\_seconds) | Maximum age of a request that Lambda sends to a function for processing in seconds. Valid values between 60 and 21600. | `number` | `null` | no |
161161
| <a name="input_maximum_retry_attempts"></a> [maximum\_retry\_attempts](#input\_maximum\_retry\_attempts) | Maximum number of times to retry when the function returns an error. Valid values between 0 and 2. Defaults to 2. | `number` | `null` | no |

0 commit comments

Comments
 (0)