You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/alias/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
# AWS Lambda Alias
2
2
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.
4
4
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.
6
6
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.
8
8
9
9
10
10
## Usage
11
11
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
13
13
14
14
```hcl
15
15
module "lambda_function" {
@@ -43,7 +43,7 @@ module "alias_no_refresh" {
43
43
44
44
### Lambda Alias (auto-refreshing when version changed externally)
45
45
46
-
This is useful when doing complex deployments using external tool.
46
+
This is useful when doing complex deployments using an external tool.
47
47
48
48
```hcl
49
49
module "alias_refresh" {
@@ -56,7 +56,7 @@ module "alias_refresh" {
56
56
57
57
### Lambda Alias (using existing alias)
58
58
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.
60
60
61
61
```hcl
62
62
module "alias_refresh" {
@@ -86,7 +86,7 @@ module "alias_existing" {
86
86
87
87
## Conditional creation
88
88
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.
90
90
91
91
```hcl
92
92
module "lambda" {
@@ -155,7 +155,7 @@ No modules.
155
155
| <aname="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 |
156
156
| <aname="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 |
157
157
| <aname="input_event_source_mapping"></a> [event\_source\_mapping](#input\_event\_source\_mapping)| Map of event source mapping |`any`|`{}`| no |
158
-
| <aname="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
+
| <aname="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|
159
159
| <aname="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 |
160
160
| <aname="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 |
161
161
| <aname="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