Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
julianwood authored Jul 13, 2023
1 parent e3bcf89 commit 9a6f416
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions apigw-kinesis-lambda-ddb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ Once the application is deployed:
- Invoke the endpoint from Postman using some json payload and verify the payload saved in DynamoDB.

Request:
- Request URL: https://{RestApiEndpoint}.execute-api.us-east-1.amazonaws.com/{gatewayStage}/submit/{streamName}/{eventId}
- Request URL: https://{RestApiEndpoint}.execute-api.{Region}.amazonaws.com/{gatewayStage}/submit/{streamName}/{eventId}
- Region - Name of AWS Resion, Example: us-east-1
- gatewayStage - Name of the API Gateway Stage. A stage is a named reference to a deployment, which is a snapshot of the API. "prod" is the stage name used in the SAM template.
- streamName - This is the name of kinesis stream created i.e., GatewayEventsStream
- eventId - Value in this attribute is used to choose PartitionKey in Kinesis stream. This example uses a single shard but when multiple shards are used, this eventId should be unique to share the load with multiple shards. Example: 55ad376f-86bf-4b06-9d3a-23237464dbd4
Expand All @@ -61,20 +62,17 @@ Request:
- Request Header: "Authorization: Basic <credentials>" (where credentials is the Base64 encoding of ID and password joined by a single colon :)
- Request Body: {"eventId":"value1", "message":"event message for testing"} (This could be any JSON payload)

Example URL: https://abc1234def.execute-api.us-east-1.amazonaws.com/prod/submit/GatewayEventsStream/55ad376f-86bf-4b06-9d3a-23237464dbd4

## Cleanup

1. Delete the stack
```bash
aws cloudformation delete-stack --stack-name STACK_NAME
```
1. Confirm the stack has been deleted
```bash
aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'STACK_NAME')].StackStatus"
sam delete
```

This pattern was contributed by Ravi Kiran Ganji.

----
Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0
SPDX-License-Identifier: MIT-0

0 comments on commit 9a6f416

Please sign in to comment.