Adding parameters to aws lambda events using templates

Question

How do I add a (path) parameter to lambda function events using cloud formation templates?

Strangely using:

DeleteItem:
          Type: Api
          Properties:
            Path: /item/{id}
            Method: delete
            Request:
            Parameters:
              Paths:
                id: true

works using aws-sam-cli. However when I try to deploy using cloud formation it says that property Request is not defined. I got this request idea from the serverless docs but seems to only work locally. I can't find documentation on how to do this in templates so any help would be greatly appreciated.

Zachscs · Accepted Answer · 2018-11-14 23:27:24Z

24

The Serverless Framework uses its own syntax, which is different from SAM (although can be compiled down to SAM or raw CloudFormation).

You can find the SAM specification here.

It's not explicit, but all you need to do is use the {path-name} syntax. Adding Request/Parameters is not required (or supported).

For example:

Ratings:
  Type: AWS::Serverless::Function
  Properties:
    Handler: ratings.handler
    Runtime: python3.6
    Events:
      Api:
        Type: Api
        Properties:
          Path: /ratings/{id}
          Method: get

Would give you the an event with:

event.pathParameters.id == 'whatever-was-put-in-the-id-position'

(A long example can be found here: https://github.com/1Strategy/redirect/blob/master/redirect.yaml)

edited Nov 14, 2018 at 23:27

Zachscs

3,6937 gold badges32 silver badges54 bronze badges

answered Nov 9, 2018 at 9:34

thomasmichaelwallace

8,5721 gold badge33 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Syed Waqas Over a year ago

Is there a way to specify query string parameters? I couldn't figure from the SAM docs.

thomasmichaelwallace Over a year ago

@WaqasShah - you don't have to specify query string parameters (afaik you can't), they'll just be available under event.queryStringParameters: docs.aws.amazon.com/lambda/latest/dg/…

manpreet Over a year ago

@thomasmichaelwallace: Yes these are available but if I want to mark some query param as required like what i can do via console. Is there any way to define that in SAM template. Thanks!

Collectives™ on Stack Overflow

Adding parameters to aws lambda events using templates

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related