From 86fb73c40b8622e1265a054bfc2666544c2863dc Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Wed, 22 Feb 2023 13:08:45 +0100 Subject: [PATCH] Update README.md --- .../spring-cloud-function-adapter-aws-web/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/README.md b/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/README.md index 1ae0d83c2..fbc13b631 100644 --- a/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/README.md +++ b/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/README.md @@ -3,4 +3,10 @@ This module represents a concept of a light weight AWS forwarding proxy which deploys and interacts with existing Spring Boot web application deployed as AWS Lambda. -A sample is provided in `/sample` directory \ No newline at end of file +A sample is provided in [sample](https://github.com/spring-cloud/spring-cloud-function/tree/serverless-web/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/sample/pet-store) directory. It contain README and SAM template file to simplify the deployment. This module is identified as the only additional dependnecy to the existing web-app. + +_NOTE: Although this module is AWS specific, this dependency is protocol only (not binary), tehrefore there is no AWS dependnecies._ + +The aformentioned proxy is identified as AWS Lambda [handler](https://github.com/spring-cloud/spring-cloud-function/blob/serverless-web/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/sample/pet-store/template.yml#L14) + +The main Spring Boot configuration file is identified as [MAIN_CLASS](https://github.com/spring-cloud/spring-cloud-function/blob/serverless-web/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/sample/pet-store/template.yml#L22)