CDK Serverless is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) in serverless architectures. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for serverless applications. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.
- Projen helper classes to configure certain use cases easily
- AWS CDK L3-construct for RestApi and GraphQlApi
- Zero-config for Lambda functions and VTL templates
- Live update to Lambda function code using cdk-watch
- Automatic DynamoDB SingleTable infrastructure
- Automatic monitoring added for Lambda functions and APIs
- Full features of CDK usable to implement your special use cases
- Fully typed auto-completion for routes, resolvers, etc.
Video about the idea behind it: https://www.youtube.com/watch?v=k5L8U39_16k
To start a new project we recommend using projen. To use CDK Serverless you can create any projen CDK Typescript app and then add the appropriate aspect provided by this toolkit.
$ npx projen new awscdk-app-ts
Adding CDK Serverless is a two step process:
- Add 'cdk-serverless' as a dependency to your project
- Run
npx projen
to install it
Now you can use the project type ServerlessProject
for your repo.
First you need to add the desired construct to your projen configuration: (e.g. RestApi)
import { RestApi } from 'cdk-serverless/projen';
new RestApi(project, {
apiName: 'TestApi', // logical name of your API
definitionFile: 'testapi.yaml', // path to your OpenAPI spec
});
Then run projen to generate construct files and models for the API.
In your stack you can then reference the generated L3s to create the API:
import { TestApiRestApi } from './generated/rest.testapi-api.generated';
const api = new TestApiRestApi(this, 'Api', {
stageName: props.stageName,
domainName: props.domainName,
apiHostname: 'api',
singleTableDatastore,
cors: true,
additionalEnv: {
DOMAIN_NAME: props.domainName,
},
});
This will also create Lambda functions for all operations defined in your spec and wire them accordingly.
-
Ensure the bug was not already reported by searching on GitHub under Issues.
-
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
-
Open a new GitHub pull request with the patch.
-
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will normally not be accepted.
-
Suggest your change under Issues.
-
Do not open a pull request on GitHub until you have collected positive feedback about the change.
- Just file a PR with your recommended changes
Brought to you by Taimos