Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
spirius committed Nov 27, 2023
1 parent 1c54fc3 commit ecf535c
Showing 1 changed file with 4 additions and 36 deletions.
40 changes: 4 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,41 +24,9 @@ pnpm add -D @cloudventure/sdf

### Bundler

`Bundler` is an abstract class for defining the source code or docker image of [Lambda](#lambda) functions.
`Bundler` is a construct for bundling the code for [Lambda](#lambda) functions.

Currently there are two bundler available:
Currently supported languages are: `typescript` and `custom`.
Currently supported bundiling methods are: `none`, `direct`, `s3` and `docker`.

- `BundlerTypeScript` class for TypeScript lambda function.
- `BundlerDocker` class for dockerized lambda functions.

#### TypeScript

`BundlerTypeScript` class is a bundler for TypeScript language. It include code generation routines which takes care
of generating the boilerplate code for entry-points and automatically links them to AWS HTTP API routes.

### Resource

Resources encapsulate cloud resources (S3 Buckets, DynamoDB tables, etc.) and they can be attached to Lambda functions.

Resources pass parameters to Lambda functions through environment variables and attach IAM policies to the function to allows access to the resource.

Resources are available to all Lambdas withing the same TerraformStack.

### Lambda

`Lambda` class is a convinient class for defining a lambda functions within SDF applications.

### API

`HttpApi` class consumes OpenAPI specification and provides:

- generation of entrypoints based on OpenAPI paths
- generation of validators based on OpenAPI parameter and body specification
- AWS HTTP API definition
- AWS Lambda functions and related resources definition
- interfaces file generation based on OpenAPI specs
- resource configuration getters

## Examples

- [AWS HTTP API with Lambda Authorizer](./examples/api-lambda-auth/)
TBD

0 comments on commit ecf535c

Please sign in to comment.