This project demonstrates how to establish an REST-ful API with API Gateway and Lambda functions. This can be an effective way to stand up an API that has inconsistent loads, is accessed infrequently, or does not have particularly high performance requirements.
Using these directions will set up various AWS services, all of which have a free tier option:
- Lambda - 1 Million Free Requests Per Month
- API Gateway - 1 Million API Calls Per Month
Be aware of these limitations before deploying services, and be sure to tear down services that are no longer being
used with terraform destroy (explained in more detail later) to minimize unnecessary costs.
Follow the following sections in the main README.md:
- Set Up AWS Account
- Install Terraform
- Install The AWS CLI
- Log In With AWS SSO
- Set The AWS_PROFILE Environment Variable
- Common Modules
If the SSO session has timed out, use aws sso login -profile=my-profile-name substituting the profile name selected
in general setup.
- Build the SampleApiLambda project in Release mode
- Navigate to the
iac/sample-api-lambdadirectory - Modify provider.tf and modify the s3 Terraform state bucket name to be unique
- Use
terraform applyto deploy the system
Once the system is deployed:
- In the AWS Management Console, from the
Searchmenu findAPI Gatewayand open it - Select the
Sample API Gatewayfrom the list of APIs - Click the
Deploy APIbutton in the upper right hand corner - Select the "staging" option from the
Stagelist and clickDeploy - Through the API Gateway stage tree, go to the
staging > / > /api > GETpath and copy the Invoke URL - Use that URL to make a GET HTTP request with an HTTP client.
curl https://<youridentifier>.execute-api.us-east-1.amazonaws.com/staging/apiis one way to accomplish this, as is the use of a client like Postman.
To clean up when done, run terraform destroy
