Skip to content

Commit 9072489

Browse files
authored
Merge pull request #2 from enter-at/github-actions/auto-readme-1576245558
Automatic Update of README.md
2 parents ea504e5 + 08346a9 commit 9072489

File tree

2 files changed

+40
-7
lines changed

2 files changed

+40
-7
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# terraform-module-template [![Build Status](https://github.com/enter-at/terraform-module-template/workflows/Terraform%20Lint/badge.svg)](https://github.com/enter-at/terraform-module-template/actions) [![Latest Release](https://img.shields.io/github/release/enter-at/terraform-module-template.svg)](https://github.com/enter-at/terraform-module-template/releases/latest) [![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
1616

1717

18-
Terraform module designed to facilitate ...
18+
Terraform module designed to facilitate the creation of AWS Lambda layers.
1919

2020

2121
---
@@ -51,14 +51,30 @@ module "module" {
5151

5252
| Name | Description | Type | Default | Required |
5353
|------|-------------|:----:|:-----:|:-----:|
54-
| enabled | (Optional) Set whether to enable the module. Defaults to true. | bool | `true` | no |
54+
| compatible_runtimes | (Optional) A list of Runtimes this layer is compatible with. Up to 5 runtimes can be specified. | list(string) | `null` | no |
55+
| description | (Optional) Description of what the Lambda layer does. | string | `null` | no |
56+
| layer_name | (Required) A unique name for the Lambda Layer. | string | - | yes |
57+
| package_file | (Optional) The location of the package manager config file. Can be one of (package.json, requirements.txt, Pipfile) | string | `null` | no |
58+
| rsync_pattern | (Optional) A list of rsync pattern to include or exclude files and directories. | list(string) | `<list>` | no |
59+
| source_dir | (Optional) The location of the Lamvda layer source code. Requires source_type to be defined. | string | `null` | no |
60+
| source_type | (Optional) The location of the Lambda layer source type. Can be one of (nodejs, python) | string | `null` | no |
61+
62+
## Outputs
63+
64+
| Name | Description |
65+
|------|-------------|
66+
| arn | The Amazon Resource Name (ARN) of the Lambda layer with version. |
67+
| created_date | The date the layer was created. |
68+
| layer_arn | The Amazon Resource Name (ARN) of the Lambda layer without version. |
69+
| source_code_size | The size in bytes of the layer .zip file. |
70+
| version | The Lamba layer version. |
5571

5672

5773

5874

5975
## Share the Love
6076

61-
Like this project?
77+
Like this project?
6278
Please give it a ★ on [our GitHub](https://github.com/enter-at/terraform-module-template)!
6379

6480

@@ -128,11 +144,12 @@ See [LICENSE](LICENSE) for full details.
128144

129145
### Contributors
130146

131-
| [![Steffen Leistner][sleistner_avatar]][sleistner_homepage]<br/>[Steffen Leistner][sleistner_homepage] |
132-
|---|
147+
148+
[![Steffen Leistner][sleistner_avatar]][sleistner_homepage]
149+
133150

134151
[sleistner_homepage]: https://github.com/sleistner
135-
[sleistner_avatar]: https://res.cloudinary.com/enter-at/image/fetch/w_100,h_100,c_thumb/https://github.com/sleistner.png
152+
[sleistner_avatar]: https://res.cloudinary.com/enter-at/image/fetch/f_png,r_max,w_100,h_100,c_thumb/https://github.com/sleistner.png
136153

137154

138155

docs/terraform.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,21 @@
22

33
| Name | Description | Type | Default | Required |
44
|------|-------------|:----:|:-----:|:-----:|
5-
| enabled | (Optional) Set whether to enable the module. Defaults to true. | bool | `true` | no |
5+
| compatible_runtimes | (Optional) A list of Runtimes this layer is compatible with. Up to 5 runtimes can be specified. | list(string) | `null` | no |
6+
| description | (Optional) Description of what the Lambda layer does. | string | `null` | no |
7+
| layer_name | (Required) A unique name for the Lambda Layer. | string | - | yes |
8+
| package_file | (Optional) The location of the package manager config file. Can be one of (package.json, requirements.txt, Pipfile) | string | `null` | no |
9+
| rsync_pattern | (Optional) A list of rsync pattern to include or exclude files and directories. | list(string) | `<list>` | no |
10+
| source_dir | (Optional) The location of the Lamvda layer source code. Requires source_type to be defined. | string | `null` | no |
11+
| source_type | (Optional) The location of the Lambda layer source type. Can be one of (nodejs, python) | string | `null` | no |
12+
13+
## Outputs
14+
15+
| Name | Description |
16+
|------|-------------|
17+
| arn | The Amazon Resource Name (ARN) of the Lambda layer with version. |
18+
| created_date | The date the layer was created. |
19+
| layer_arn | The Amazon Resource Name (ARN) of the Lambda layer without version. |
20+
| source_code_size | The size in bytes of the layer .zip file. |
21+
| version | The Lamba layer version. |
622

0 commit comments

Comments
 (0)