How to automate API Gateway deployment via SAM deploy?

Question

When I changed AWS::ApiGateway::Method properties by AWS SAM template and deployed it. but I noticed that change was not reflected until I deploy API manually from AWS management console. I think it is because I didn't change the resource of AWS::ApiGateway::Deployment and AWS::ApiGateway::Stage on the template.(The deployment history of AWS::ApiGateway::Stage was not updated.)

How can I reflect the change when I trigger sam deploy?

Related to: stackoverflow.com/questions/41423439/… As suggested in one of the answers there, a possible workaround is to (manually or automatically) run aws apigateway create-deployment after sam deploy. — Paolo Rovelli
– Paolo Rovelli, Commented Jun 23, 2023 at 12:03

Vishwasa Navada K · Accepted Answer · 2023-04-07 18:15:09Z

4

If you are still looking for a solution for this, SAM has recently(March 2023) introduced a property under AWS::Serverless::Api called AlwaysDeploy which forces API to be deployed even when there is no changes to API whenever there is sam deploy.

Reference:

Note that this will only work if you have your sam cli up to date (>v1.78.0) in your local machine or CI/CD where you will be running sam build.

answered Apr 7, 2023 at 18:15

Vishwasa Navada K

6521 gold badge9 silver badges31 bronze badges

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

Comments

Arun Kamalanathan · Accepted Answer · 2020-01-10 05:05:29Z

1

No, you have to manually deploy the api from the console :) it's a limitation at the moment.

answered Jan 10, 2020 at 5:05

Arun Kamalanathan

8,6114 gold badges29 silver badges43 bronze badges

6 Comments

d.y Over a year ago

Thank you for your quick response and noted.

Arun Kamalanathan Over a year ago

I have not tried this approach, looks like if you change the logical name of the deployment resource, it will trigger the deployment it seems, have a crack at it if you want, medium.com/@ngchiwang/…

d.y Over a year ago

Thanks. I understand the approach to always recreate the stage resource by putting timestamp. wow. I'll try it.

d.y Over a year ago

but I noticed I always need to put timestamp when I modify the setting related to API gateway. have to remember to change...

Arun Kamalanathan Over a year ago

Ya it's not the best solution

|

Collectives™ on Stack Overflow

How to automate API Gateway deployment via SAM deploy?

2 Answers 2

Comments

6 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

6 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related