sam-app

This is a sample template for sam-app Updating the readme file - This is an update on Markdown file .

Comments added by Thilakar .K - Starts (14-04-2021)

Additional exception handling added

Comments added by Thilakar .K - Ends (14-04-2021)

Comments added by Chaudri - Starts (12-04-2021)

Technical details added

Comments added by Chaudri - Ends (12-04-2021)

Comments added by Pooja - Starts (17-04-2021)

Additional links and details added

Comments added by Pooja - Ends (17-04-2021)

Requirements

• AWS CLI already configured with at least PowerUser permission
• Docker installed
• SAM Local installed
• DotNet Core installed

Setup process

Linux & macOS

sh build.sh --target=Package

Windows (Powershell)

build.ps1 --target=Package

Local development

Invoking function locally through local API Gateway

sam local start-api

SAM Local is used to emulate both Lambda and API Gateway locally and uses our template.yaml to understand how to bootstrap this environment (runtime, where the source code is, etc.) - The following excerpt is what the CLI will read in order to initialize an API and its routes:

...
Events:
    sam-app:
        Type: Api # More info about API Event Source: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
        Properties:
            Path: /hello
            Method: get

If the previous command run successfully you should now be able to hit the following local endpoint to invoke your function http://localhost:3000/hello

Packaging and deployment

AWS Lambda C# runtime requires a flat folder with all dependencies including the application. SAM will use CodeUri property to know where to look up for both application and dependencies:

...
    FirstFunction:
        Type: AWS::Serverless::Function
        Properties:
            CodeUri: src/HelloWorld/bin/Debug/netcoreapp2.0/publish            
            ...

First and foremost, we need an S3 bucket where we can upload our Lambda functions packaged as ZIP before we deploy anything - If you don't have a S3 bucket to store code artifacts then this is a good time to create one:

aws s3 mb s3://BUCKET_NAME

Next, run the following command to package our Lambda function to S3:

sam package \
    --template-file template.yaml \
    --output-template-file packaged.yaml \
    --s3-bucket REPLACE_THIS_WITH_YOUR_S3_BUCKET_NAME

Next, the following command will create a Cloudformation Stack and deploy your SAM resources.

sam deploy \
    --template-file packaged.yaml \
    --stack-name sam-app \
    --capabilities CAPABILITY_IAM

See Serverless Application Model (SAM) HOWTO Guide for more details in how to get started.

After deployment is complete you can run the following command to retrieve the API Gateway Endpoint URL:

aws cloudformation describe-stacks \
    --stack-name sam-app \
    --query 'Stacks[].Outputs'

Testing

For testing our code, we use XUnit and you can use dotnet test to run tests defined under test/

dotnet test test/HelloWorld.Test

Alternatively, you can use Cake. It discovers and executes all the tests.

Linux & macOS

sh build.sh --target=Test

Windows (Powershell)

build.ps1 --target=Test

Appendix

AWS CLI commands

AWS CLI commands to package, deploy and describe outputs defined within the cloudformation stack:

aws cloudformation package \
    --template-file template.yaml \
    --output-template-file packaged.yaml \
    --s3-bucket REPLACE_THIS_WITH_YOUR_S3_BUCKET_NAME

aws cloudformation deploy \
    --template-file packaged.yaml \
    --stack-name sam-app \
    --capabilities CAPABILITY_IAM \
    --parameter-overrides MyParameterSample=MySampleValue

aws cloudformation describe-stacks \
    --stack-name sam-app --query 'Stacks[].Outputs'

Bringing to the next level

Here are a few ideas that you can use to get more acquainted as to how this overall process works:

• Create an additional API resource (e.g. /hello/{proxy+}) and return the name requested through this new path
• Update unit test to capture that
• Package & Deploy

Next, you can use the following resources to know more about beyond hello world samples and how others structure their Serverless applications:

• AWS Serverless Application Repository