This is a AWS CDK stack definition.
It is designed as simple, extremely cheap to host, but highly scalable API that can be used as a starting point for building your own API.
- 🌐 AWS API Gateway
- 🚀 Individual AWS Lambda endpoints (TypeScript)
- 📖 Self-documented with OpenAPI 3.0 spec generated by the API Gateway itself
- 🔒 Custom Hosted Zone with SSL certificate
- 🔑 SSO Authorization using AWS Cognito as a shared Auth service
- 📦 Deployed as a
cweb.pkgcomponent via Management API
- Clone this repository
- Run
npm installto install dependencies - Run
npm testto run the tests - Run
npm run lintto fix any linting issues
Use package workflows to deploy through Connected Web Management API:
This stack is designed to be deployed to multiple environments. The following environments are supported:
connected-web-dev- Development environmentconnected-web-prod- Production environment
These environments are preconfigured with a Hosted Zone and SSL certificate and AWS Cognito user pools.
This stack uses AWS Cognito shared authentication only.
The synthesized template declares deploy-time CloudFormation parameters for shared authorizer wiring:
IDENTITY_AUTHORIZER_ARN
The template also expects deploy-time domain parameters:
SubdomainHostedZoneDomainHostedZoneId
In package-based deployment these values are passed or injected by Management API during deployment.