5

I have a lambda function that needs to be triggered via Amazon API Gateway. Is there a way to include an already existing API (created using the AWS console) into AWS SAM template?

Shoejep
  • 4,414
  • 4
  • 22
  • 26
A Teja
  • 51
  • 1
  • 2
  • you can use AWS::Serverless::Api, have you checked this page? https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-api.html – ZEE Aug 03 '20 at 16:02
  • This will create a new api ,but I want to use an already existing api in template file – A Teja Aug 05 '20 at 07:56

1 Answers1

3

SAM doesn't support the !ImportValue in the template yet.

Issue on Github

On the GitHub of the aws/serverless-application-model there's an open PR for that feature

See here

If you want you could help and contribute to that PR so then you could start using !ImportValue in your SAM template.yml

Else, I suggest you go with the old way, you create a CI/CD with a CloudFormation template that can use the !ImportValue and is linked to an S3 bucket where your lambda function code lives.

Examples of Cloudformation Templates

Update

SAM CLI now support the !ImportValue, the issue on Github is closed.

You can use it as follow

# You need to export the resource that you want to use in another template first

# This goes at the end of your template.yml file, after the Resources

# template.yml in the first repo
Outputs:
    myExportedResource:
        Value: !Ref TheResource
        Export:
            Name: !Sub "{environment}-nice-export-name"


# template.yml in the second repo (This obviously goes in Resources)
    MyLambda:
        Type: AWS::Serverless::Function
        Properties:
            FunctionName: awesome-lambda
            CodeUri: ./dist
            Handler: this-file.handler
            Role: !GetAtt LambdaRole.Arn
            VpcConfig:
                SecurityGroupIds:
                    - !GetAtt SecurityGroup.GroupId
                SubnetIds:
                    - Fn::ImportValue: !Sub "${environment}-nice-export-name"

You can use it exactly as a normal cloudformation template

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html

Note that here I used Fn:ImportValue because I needed to use !Sub but if you don't need to reference a parameter in your import value simply use !ImportValue

Benjamin Filiatrault
  • 530
  • 1
  • 7
  • 19
  • Any documentation on how exactly can we use the `!ImportValue`? – Mooncrater Jul 02 '21 at 05:22
  • 1
    @Mooncrater I updated my response with a code example. You can use it exactly like a normal cloudformation `!ImportValue`. Make sure to have the latest sam cli version. You can check the version by typing `sam --version` in your shell. make sure to at least the version 1.24.1 – Benjamin Filiatrault Jul 04 '21 at 14:39
  • @Mooncrater AWS docs here: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html – abk Sep 12 '21 at 21:48