Serverless REST API

This example lives in the pulumi/examples repository. Check out just this directory to use it:

$ git clone --filter=blob:none --sparse https://github.com/pulumi/examples pulumi-examples
$ git -C pulumi-examples sparse-checkout set aws-ts-apigateway
$ cd pulumi-examples/aws-ts-apigateway

A simple REST API that counts the number of times a route has been hit. For a detailed walkthrough of this example, see the article Create a Serverless REST API.

Deploying and running the program#

Note: some values in this example will be different from run to run. These values are indicated with ***.

1. Create a new stack:

   $ pulumi stack init count-api-testing

2. Set the AWS region:

   $ pulumi config set aws:region us-east-2

3. Restore NPM modules via npm install or yarn install.

4. Run pulumi up to preview and deploy changes:

   $ pulumi up
   Previewing update of stack 'count-api-testing'
   ...
   
   Updating (count-api-testing):
   
        Type                                Name                                 Status
    +   pulumi:pulumi:Stack                 aws-ts-apigateway-count-api-testing  created
    +   ├─ aws:apigateway:x:API             hello-world                          created
    +   │  ├─ aws:iam:Role                  hello-world4fcc7b60                  created
    +   │  ├─ aws:iam:RolePolicyAttachment  hello-world4fcc7b60-32be53a2         created
    +   │  ├─ aws:lambda:Function           hello-world4fcc7b60                  created
    +   │  ├─ aws:apigateway:RestApi        hello-world                          created
    +   │  ├─ aws:apigateway:Deployment     hello-world                          created
    +   │  ├─ aws:lambda:Permission         hello-world-a552609d                 created
    +   │  └─ aws:apigateway:Stage          hello-world                          created
    +   └─ aws:dynamodb:Table               counterTable                         created
   
   Outputs:
       endpoint: "https://***execute-api.us-east-2.amazonaws.com/stage/"
   
   Resources:
       + 10 created
   
   Duration: 24s

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

   $ pulumi stack output
   Current stack outputs (1):
       OUTPUT            VALUE
       endpoint          https://***.us-east-2.amazonaws.com/stage/
   
   $ curl $(pulumi stack output endpoint)/hello
   {"route":"hello","count":1}
   $ curl $(pulumi stack output endpoint)/hello
   {"route":"hello","count":2}
   $ curl $(pulumi stack output endpoint)/woohoo
   {"route":"woohoo","count":1}

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

Clean up#

1. Run pulumi destroy to tear down all resources.

2. To delete the stack itself, run pulumi stack rm. Note that this command deletes all deployment history from the Pulumi console.