Skip to content

Commit 0329fcd

Browse files
committed
modified documentation
1 parent 3ec2103 commit 0329fcd

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

  • lambda-elastic-ip-no-nat-gateway-cdk

lambda-elastic-ip-no-nat-gateway-cdk/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ Important: This application uses various AWS services and there are costs associ
3030
```bash
3131
cd serverless-patterns/lambda-elastic-ip-no-nat-gateway-cdk/cdk
3232
```
33-
3. Install dependencies:
33+
3. Install dependencies for both the infrastructure project and the typescript project:
3434
```bash
3535
npm install
36+
cd src
37+
npm install
3638
```
3739

3840
```typescript
@@ -67,19 +69,18 @@ app.synth();
6769

6870
## How it works
6971

70-
This pattern allows you to assign your lambda function a static public IP address that you can use to interact with APIs that require whitelisted IPs without the need to provision a NAT Gateway. Therefore, this pattern will save almost $33/month in NAT Gateway costs.
72+
This pattern allows you to assign your lambda function a static public IP address that you can use to interact with APIs that require whitelisted IPs without the need to provision a NAT Gateway. Therefore, this pattern will save almost **$33/month** in NAT Gateway costs.
7173

7274

7375
The following resources will be provisioned:
7476

7577
- A Lambda function to test the pattern
7678
- An Elastic IP to associate with the Lambda function
77-
- A public subnet in the default VPC
7879
- A custom resource with Lambda function to associate the Elastic IP with the test lambda's ENI
7980

80-
Since AWS manages the provisioning of any Lambda ENI, we cannot access that ENI in CDK code. Therefore, to automate the process, we have to associate the Elastic IP with the ENI in a custom resource after the deployment occurs.
81+
Since AWS manages the provisioning of any Lambda ENI, we cannot access that ENI in CDK code. Therefore, to automate the process, we have to associate the Elastic IP with the ENI in a custom resource after the deployment occurs and the ENI is provisioned.
8182

82-
**_Disclaimer:_** This pattern is best suited for non-production environments since it is not multi-AZ nor highly scalable.
83+
##### **NOTE:** This pattern is best suited for non-production environments since it is not multi-AZ nor highly scalable.
8384

8485
## Testing
8586

@@ -90,7 +91,7 @@ To test this pattern, you must use both the AWS Console and the AWS CLI.
9091
1. Open the AWS Lambda Console
9192
2. Navigate to `vin-api-lambda`
9293
3. Test the lambda with any payload
93-
4. A random vin should be returned and logged.
94+
4. The lambda shouldn't time out and a random vin should be returned and logged.
9495

9596

9697
## Cleanup

0 commit comments

Comments
 (0)