Skip to content
This repository was archived by the owner on Mar 19, 2024. It is now read-only.

Commit b4b6cb5

Browse files
author
CodingNagger
committed
Update documentation
1 parent 578d644 commit b4b6cb5

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ Steps:
212212

213213
There are many ways to achieve a lambda deployment (AWS Console, SAM, CloudFormation ...), please refer to the latest [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) to know more.
214214

215-
#### Requirements
215+
## Requirements
216216

217217
- an AWS account for test purpose.
218218
- aws cli: Install the aws cli. Here the [instructions](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html).
@@ -244,7 +244,7 @@ Datetime based versions are created and uploaded to S3 every time your version i
244244
make upload_lambda_layer
245245
```
246246

247-
#### 2) Create the Lambda
247+
### 2) Create the Lambda
248248

249249
You can create a new lambda which might take a few minutes using one of the options below:
250250

@@ -277,7 +277,7 @@ The lambda is created with the following parameters:
277277

278278
This step is required once, if you need to update the lambda use the step 5.
279279

280-
#### 4) Invoke the Lambda
280+
### 4) Invoke the Lambda
281281
Now the lambda function is ready for testing. The following command invokes the lambda with using the file **event.json** contained in the project folder.
282282

283283
```console
@@ -301,7 +301,7 @@ Note:
301301

302302
The lambda invocation may require some policy to access other AWS Resources. Check the `S3Test` example to know more.
303303

304-
#### 5) Update the Lambda (optional)
304+
### 5) Update the Lambda (optional)
305305

306306
If needed, you will also be able to update your Lambda using one of the commands below:
307307

@@ -317,6 +317,16 @@ make update_lambda_with_s3
317317
make update_lambda
318318
```
319319

320+
### 6) Nuclear option
321+
322+
Sometimes you want to go back to a clean slate and we have a command for that which will rely on the parameters you use.
323+
324+
```console
325+
make nuke
326+
```
327+
328+
That command will clean your local build folders and delete S3 buckets, lambdas and layers created based off the configuration you use.
329+
320330
# Update the lambda layer
321331

322332
The docker image could require security updates or could require updates.

0 commit comments

Comments
 (0)