Skip to content

Commit 768c536

Browse files
committed
README updated
1 parent 8ff549c commit 768c536

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

apigw-lambda-dsql/README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# AWS Service 1 to AWS Service 2
1+
# Amazon API Gateway, AWS Lambda and Amazon Aurora DSQL
22

3-
This pattern << explain usage >>
3+
Amazon Aurora DSQL is the fastest serverless, distributed SQL database with active-active high availability and multi-Region strong consistency. Aurora DSQL enables you to build always available applications with virtually unlimited scalability, the highest availability, and zero infrastructure management. It is designed to make scaling and resilience effortless for your applications and offers the fastest distributed SQL reads and writes.
44

5-
Learn more about this pattern at Serverless Land Patterns: << Add the live URL here >>
5+
This pattern deploys a API Gateway REST API, Lambda function and an Aurora DSQL PostgreSQL cluster.
6+
7+
Learn more about this pattern at [Serverless Land Patterns](https://serverlessland.com/patterns/apigw-lambda-dsql)
68

79
Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
810

@@ -21,15 +23,16 @@ Important: this application uses various AWS services and there are costs associ
2123
```
2224
1. Change directory to the pattern directory:
2325
```
24-
cd _patterns-model
26+
cd apigw-lambda-dsql
2527
```
2628
1. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:
2729
```
30+
sam build
2831
sam deploy --guided
2932
```
3033
1. During the prompts:
3134
* Enter a stack name
32-
* Enter the desired AWS Region
35+
* Enter the desired AWS Region (verify which [regions Aurora DSQL is available in](https://aws.amazon.com/rds/aurora/dsql/faqs/))
3336
* Allow SAM CLI to create IAM roles with the required permissions.
3437
3538
Once you have run `sam deploy --guided` mode once and saved arguments to a configuration file (samconfig.toml), you can use `sam deploy` in future to use these defaults.
@@ -38,23 +41,26 @@ Important: this application uses various AWS services and there are costs associ
3841
3942
## How it works
4043
41-
Explain how the service interaction works.
44+
This sample project demonstrates how to use a Lambda function (invoked by API Gateway), that stores and retrieves data from an Amazon Aurora DSQL PostgreSQL cluster.
4245
4346
## Testing
4447
45-
Provide steps to trigger the integration and show what should be observed if successful.
48+
Use the `Value` from `UsersApi` URL output from the above `sam deploy` command to invoke the API Gateway API, e.g:
49+
`curl https://abc123.execute-api.eu-west-1.amazonaws.com/Prod/users/`
50+
which should return with
51+
`{"id": "e3ce23b5-c6a1-4289-bb02-2f34a2f7b956", "name": "John", "city": "LA", "telephone": "555-555-0150"}`
4652
4753
## Cleanup
4854
4955
1. Delete the stack
5056
```bash
51-
aws cloudformation delete-stack --stack-name STACK_NAME
57+
sam delete
5258
```
5359
1. Confirm the stack has been deleted
5460
```bash
5561
aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'STACK_NAME')].StackStatus"
5662
```
5763
----
58-
Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
64+
Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
5965
6066
SPDX-License-Identifier: MIT-0

0 commit comments

Comments
 (0)