TiDB Cloud + AWS Cloudformation Bookshop Demo

Note:

All resources created in this section will be charged to your AWS account. Please make sure you have enough credits in your account before proceeding.

The defualut region is us-east-1.

If you are not in this region, you should change the region in aws-lambda-cloudformation/src/secretManager.ts and create your code bundle by yourself.

1. Create a Secrets Manager service

Visit Secrets Manager service in AWS Management Console, and click Store a new secret button.

Input TiDBDatabase, TiDBUser, TiDBPassword, TiDBHost and TiDBPort which are the database-related details of your TiDB Cloud cluster. You can find these details in your TiDB Cloud cluster dashboard.

Do remember input autogenerated/cloudformation/tidbcloud as the secret name, which will be used in the Lambda function.

2. Create an IAM Role for Lambda

We need to use Secrets Manager in Lambda function, so we need to create an IAM Role for Lambda to access the Secrets Manager service.

Visit IAM service in AWS Management Console, and click Roles button.

Click Create role button, and select AWS service as the trusted entity, and select Lambda as the use case.

Click Next: Permissions button, and search secretsmanager in the search box, and select SecretsManagerReadWrite policy; Search lambda and select AWSLambdaBasicExecutionRole policy.

Click Next button, and input LambdaSecretsManagerRole as the role name, and click Create role button.

3. Create Lambda functions

We will create 4 Lambda functions in this demo.

3.1 Create a Lambda function to get all books / get a book by id

Visit Lambda service in AWS Management Console, and click Create function button.

Select Author from scratch as the blueprint, and input getBookFunction as the function name, and select Node.js 18x as the runtime.

Select Change default execution role - Use an existing role, and select the LambdaSecretsManagerRole role we created in the previous step.

Click Create function button.

Click Upload a .zip file button, and upload the cloudformation-index.zip file in the latest release assets(create your own code bundle if you are not in us-east-1 region).

Click Save button.

Edit Runtime settings of the Lambda function, and set Handler to getBookHandler.handler. Click Save button.

Choose Configuration tab - General configuration, and set Timeout to 30 sec. Click Save button.

We build the Lambda function in the cloudformation-index.zip file, and you can also build it by yourself. See README for more details.

3.2 Create a Lambda function to post a new book / post initial books

Visit Lambda service in AWS Management Console, and click Create function button.

Select Author from scratch as the blueprint, and input postBookFunction as the function name, and select Node.js 18x as the runtime.

Select Change default execution role - Use an existing role, and select the LambdaSecretsManagerRole role we created in the previous step.

Click Create function button.

Click Upload a .zip file button, and upload the cloudformation-index.zip file in the latest release assets(create your own code bundle if you are not in us-east-1 region).

Click Save button.

Edit Runtime settings of the Lambda function, and set Handler to postBookHandler.handler. Click Save button.

Choose Configuration tab - General configuration, and set Timeout to 30 sec. Click Save button.

3.3 Create a Lambda function to delete a book

Visit Lambda service in AWS Management Console, and click Create function button.

Select Author from scratch as the blueprint, and input deleteBookFunction as the function name, and select Node.js 18x as the runtime.

Select Change default execution role - Use an existing role, and select the LambdaSecretsManagerRole role we created in the previous step.

Click Create function button.

Click Upload a .zip file button, and upload the cloudformation-index.zip file in the latest release assets(create your own code bundle if you are not in us-east-1 region).

Click Save button.

Edit Runtime settings of the Lambda function, and set Handler to deleteBookHandler.handler. Click Save button.

Choose Configuration tab - General configuration, and set Timeout to 30 sec. Click Save button.

3.4 Create a Lambda function to update a book

Visit Lambda service in AWS Management Console, and click Create function button.

Select Author from scratch as the blueprint, and input putBookFunction as the function name, and select Node.js 18x as the runtime.

Select Change default execution role - Use an existing role, and select the LambdaSecretsManagerRole role we created in the previous step.

Click Create function button.

Click Upload a .zip file button, and upload the cloudformation-index.zip file in the latest release assets(create your own code bundle if you are not in us-east-1 region).

Click Save button.

Edit Runtime settings of the Lambda function, and set Handler to putBookHandler.handler. Click Save button.

Choose Configuration tab - General configuration, and set Timeout to 30 sec. Click Save button.

4. Create an API Gateway

Visit API Gateway service in AWS Management Console, and click Create API button.

Select HTTP API as the API type.

Input TiDBCloudApiGatewayV2 as the API name.

Add Integrations for the API Gateway:

• Click Add integration button, and select Lambda function as the integration type.

• Select getBookFunction as the Lambda function.

• Use default settings for other fields.

• Create other three integrations for postBookFunction, deleteBookFunction and putBookFunction Lambda functions.

Click Next : Configure routes button.

• Click Add route button, input GET /book as the route name, and select getBookFunction as the integration.

• Click Add route button, input GET /book/{id} as the route name, and select getBookFunction as the integration.

• Click Add route button, input POST /book as the route name, and select postBookFunction as the integration.

• Click Add route button, input POST /book/init as the route name, and select postBookFunction as the integration.

• Click Add route button, input DELETE /book/{id} as the route name, and select deleteBookFunction as the integration.

• Click Add route button, input PUT /book/{id} as the route name, and select putBookFunction as the integration.

Click Next : Define stages button.

Use the default settings.

Click Next : Review button.

Click Create button.