Skip to content

Commit

Permalink
edits to README to better fit instructions found in pulumi/examples/C…
Browse files Browse the repository at this point in the history
…ONTRIBUTING.md
  • Loading branch information
Hitesh Boinpally authored and Hitesh Boinpally committed Mar 25, 2021
1 parent 139a088 commit 692c93c
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions aws-py-apigatewayv2-http-api-quickcreate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

# AWS API Gateway V2 HTTP API Quickstart

Set up a simple HTTP API using AWS API Gateway V2. The API executes a simple lambda function found
in `/app/index.js`.
Set up a simple HTTP API using AWS API Gateway V2. The API executes a simple Lambda with function
found in `/app/index.js`.

## Prerequisites
1. Install [Pulumi](https://www.pulumi.com/docs/get-started/install/).
2. Configure [Pulumi for AWS](https://www.pulumi.com/docs/intro/cloud-providers/aws/setup/).
3. Install [Python 3.6](https://www.python.org/downloads/) or higher.
3. Install [Python](https://www.pulumi.com/docs/intro/languages/python).

## Deploying and running the program

Expand All @@ -27,8 +27,6 @@ with `***`.
$ pulumi config set aws:region us-east-2
```

1. Restore NPM modules via `npm install` or `yarn install`.

1. Run `pulumi up` to preview and deploy changes:

```
Expand All @@ -54,6 +52,8 @@ with `***`.
Duration: 22s
```
Note: this command will create a virtual environment and restore dependencies automatically as
described in [Pulumi docs](https://www.pulumi.com/docs/intro/languages/python/#virtual-environments).

1. View the endpoint URL and curl a few routes:

Expand All @@ -69,6 +69,11 @@ with `***`.

1. To view the runtime logs of the Lambda function, use the `pulumi logs` command. To get a log stream, use `pulumi logs --follow`.

1. At this point, you have a running HTTP API. Feel free to modify your program, and run `pulumi up`
to redeploy changes. The Pulumi CLI automatically detects what has changed and makes the minimal
edits necessary to accomplish these changes. This could be altering the function used by the Lambda,
or anything else you'd like!

## Clean up

1. Run `pulumi destroy` to tear down all resources.
Expand Down

0 comments on commit 692c93c

Please sign in to comment.