A set of Custom Resources that enables API Gateway support for CloudFormation
JavaScript HTML Shell Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

API Gateway for CloudFormation

!Project Discontinued!

This project is no longer actively maintained. Critical bug fixes may be released but no new features can be expected. Cloudformation has a decent set of native resources for API Gateway and where there is a gap in CloudFormation, I recommend using Lulo to bridge it. Lulo is a plugin engine for Custom Resources and is much more extendible and versatile than this project as the plugins can cover any AWS Service (and anything else for that matter) and not just API Gateway.

Build Status Coverage Status

API Gateway for CloudFormation is a set of Custom Resources that allows you to manage your API Gateway setup with CloudFormation. Yes, you read that right! Finally a way to integrate your backend services that you already create using CloudFormation with your APIs!

It's deployed via the CloudFormation Console and runs on AWS Lambda.

It supports API Definitions in Swagger as well as individual Cloud Formation resources depending on which flavour you prefer.

Complete documentation is available at the project website

Overview

This setup allows you to manage the majority of the API Gateway related resources. The installation will create a Lambda function in the region corresponding to the template location in your AWS account. This Lambda function is a CloudFormation Custom Resource and acts as a liaison between CloudFormation and API Gateway. Once the Lambda function has been installed you can start writing your CloudFormation templates.

If you want to learn more about CloudFormation, Custom Resources or API Gateway I suggest the following links: