-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.yaml
72 lines (54 loc) · 1.53 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: tf-mod-aws-lambda-rest-api
# Canonical Git repo
github_repo: https://github.com/Callumccr/tf-mod-aws-lambda-rest-api
# # Badges to display
# badges:
# - name: "Build Status"
# image: ""
# url: ""
# Short description of this project
description: |-
Use the `tf-mod-lambda-rest-api` module to create an AWS Gateway REST API & Deployment for existing lambda functions.
Additionally, it optionally creates the neccessary lambda permissions, security keys, and a usageplan.
# External context to include
include:
- "docs/terraform.md"
# How to use this module
usage: |-
The below values shown in the usage of this module are purely representative, please replace desired values as required.
TO-DO
```hcl
```
# Simple and advanced examples of this project
examples: |-
Simple and advanced examples of this project.
### Advanced Example 1:
TO-DO
```hcl
```
# Related projects
related:
- name:
description:
url:
# Contributor information
contributors:
- name: "Callum Robertson"
github: "callumccr"
avatar: https://media-exp1.licdn.com/dms/image/C5603AQHb_3oZMZA5YA/profile-displayphoto-shrink_200_200/0?e=1588809600&v=beta&t=5QQQAlHrm1od5fQNZwdjOtbZWvsGcgNBqFRhZWgnPx4
homepage: https://www.linkedin.com/in/callum-robertson-1a55b6110/
# Jira information
jira:
- project:
project_url:
epic:
epic_url:
user_story:
user_story_url:
---