AWS CloudFormation does not support AWS API Gateway. This is a Lambda-backed custom resource to add the AWS API Gateway's RestApi to CloudFormation.
This package on NPM
This package on GitHub
This Lambda makes use of the Lambda-Backed CloudFormation Custom Resource flow module, cfn-lambda
(GitHub / NPM).
See ./example.template.json
for a sample CloudFormation template. The example uses Condition
statements, Parameters
, and dynamic ServiceToken
generation fully.
"ApiLogicalIdInResourcesObject": {
"Type": "Type": "Custom::ApiGatewayRestApi",
"Properties": {
"ServiceToken": "arn:aws:lambda:<cfn-region-id>:<your-account-id>:function:<this-deployed-lambda-name>",
"Name": "StringNameOfApi",
"BaseApiId": "10 char alphanum ID for API (will clone API from this ID).",
"Description": "Plain freetext description."
}
}
Updating BaseApiId will require and trigger CloudFormation Resource Replacement
The way that takes 10 seconds...
# Have aws CLI installed + permissions for IAM and Lamdba
$ npm run cfn-lambda-deploy
You will have this resource installed in every supported Region globally!
... And the way more difficult way.
IMPORTANT: With this method, you must install this custom service Lambda in each AWS Region in which you want CloudFormation to be able to access the ApiGatewayRestApi
custom resource!
- Go to the AWS Lambda Console Create Function view:
-
Zip this repository into
/tmp/ApiGatewayRestApi.zip
$ cd $REPO_ROOT && zip -r /tmp/ApiGatewayRestApi.zip;
-
Enter a name in the Name blank. I suggest:
CfnLambdaResouce-ApiGatewayRestApi
-
Enter a Description (optional).
-
Toggle Code Entry Type to "Upload a .ZIP file"
-
Click "Upload", navigate to and select
/tmp/ApiGatewayRestApi.zip
-
Set the Timeout under Advanced Settings to 10 sec
-
Click the Role dropdown then click "Basic Execution Role". This will pop out a new window.
-
Select IAM Role, then select option "Create a new IAM Role"
-
Name the role
lambda_cfn_api_gateway_restapi
(or something descriptive) -
Click "View Policy Document", click "Edit" on the right, then hit "OK"
-
Copy and paste the
./execution-policy.json
document. -
Hit "Allow". The window will close. Go back to the first window if you are not already there.
-
Click "Create Function". Finally, done! Now go to Usage or see the example template. Next time, stick to the instant deploy script.
Submit pull requests or Tweet @ayetempleton if you want to get involved with roadmap as well, or if you want to do this for a living :)
Work is (extremely) active, published here:
Andrew's NPM Account