CDK Template of Table Definition AWS Lambda for RDB
Overview
This sample deploys Amazon Aurora of PostgreSQL or MySQL with AWS Lambda that can define table declaratively and seed data by AWS Cloud Development Kit (CDK).
In addition to starting Amazon Aurora, you can also initialize the database, seed data, and declaratively modify tables at any time by running lambdas.
Architecture
There is only one CDK stack.The architecture is shown below.
Directory Structures
.
├── bin
│ ├── db-definer.ts # Define CDK Stack
│ └── db-settings.ts # Define type of database family (PostgreSQL, MySQL) settings
├── lambda
│ └── db-definer
│ ├── schema # Table Definition. SQL file in this folder will be executed
│ └── seed
│ ├── mysql # Seed SQL file for MySQL
│ └── postgresql # Seed SQL file for PostgreSQL
└── lib
├── database.ts # Amazon Aurora and AWS Lambda are defined here
└── db-definer-stack.ts # VPC and database
Main Libraries
- aws-cdk
- typescript
- sqldef
- For more information, please see below.
- k0kubun/sqldef: Idempotent schema management for MySQL, PostgreSQL, and more
Prerequisites
- npm
- aws cli v2
- cdk
- docker
- configuration of aws profile
Getting Started
1. Clone the repository
- Run
git clonecommand to download the source code.
2. Deploy resources
- Run
npm cicommand in the top of this directory. - Run
npx cdk deployto deploy these resouces. - When resouces are successfully deployed, outputs such as
DbDefinerStack.DBDBLambdaNamewill be shown in the terminal. These values will be used to define tables. - You can edit DDL in
./lambda/db-definer/schemaand DML in./lambda/db-definer/seedbefore deploy.
Outputs:
DbDefinerStack.DBDBLambdaNameXXXXXXX = DbDefinerStack-DBDbDefinerXXXXXX
Stack ARN:
arn:aws:cloudformation:xyz-region-x:XXXXXXXXXXX:stack/DbDefinerStack/XXXXXXXXXXXXXXXXXX
3. Define Table
DbDefinerStack.DBDBLambdaName accept these command from event.
init
Drop and create database. You can use this command under developing. SQL file in./lambda/db-definer/schemawill be reflected.preview
Preview change the definition of table from SQL file in./lambda/db-definer/schemaby using sqldef.sync
Synchronize table in database to SQL file in./lambda/db-definer/schemaby using sqldef.
You can preview SQL that will be excuted by sqldef.seed
Run SQL file in./lambda/db-definer/seed/mysqlor./lambda/db-definer/seed/postgresql.
You can use this command for inserting seed data to database.
For example, when you want to initialize DB, run below command in the terminal.
You can excute this lambda from AWS Management Console.
aws lambda invoke --function-name [DbDefinerStack.DBDBLambdaName] --payload '{"command":"init"}' --cli-binary-format raw-in-base64-out res.txt
Security
See CONTRIBUTING for more information.
License
This library is licensed under the MIT-0 License. See the LICENSE file.
8 Sep 9, 2022
1 May 20, 2022
12 Nov 20, 2022
1 Jan 12, 2022
2 Dec 9, 2022
7 Oct 18, 2022
109 Dec 29, 2022
3 Feb 11, 2022
1 Jan 9, 2022
1 Feb 8, 2022
30 Nov 8, 2022
1.9k Jan 7, 2023
3 Aug 31, 2022
3 Feb 2, 2022
39 Oct 30, 2022
4 Jan 20, 2022
4 Mar 2, 2022
15 Jul 14, 2022
152 Dec 29, 2022
287 Nov 9, 2022
35.1k Jan 2, 2023
0 Jan 31, 2022
2 Oct 22, 2022
71 Dec 29, 2022
4 Nov 7, 2022
57 Dec 17, 2022