Adding example for deployment of a Private API gateway to AWS.

Author: Declan Carroll

web-api-postdeploy-private-gateway/README.md

@@ -0,0 +1,15 @@
+An example of a private API gateway configured to work on an AWS VPC:
+
+1. run `npm install` to grab the dependencies
+2. run `npm start` to set up the lambda project under the default name on AWS
+3. load the URL that the create command prints out -- you should see `Hello from your Private API`
+
+
+Check out [package.json](package.json) to see the configuration for the security groups and VPCEs.
+
+`Troubleshooting:`
+If after deploying your gateway you can't appear to access or resolve it, ensure that you are able to resolve URL's on the private DNS.
+
+**[Private API Considerations](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-apis.html#apigateway-private-api-design-considerations)**
+
+

web-api-postdeploy-private-gateway/package.json

@@ -0,0 +1,22 @@
+{
+ "name": "web-api-private-gateway",
+ "description": "An example of how to create a private API gateway deployment",
+ "version": "1.0.0",
+ "private": true,
+ "scripts": {
+ "start": "claudia create --region eu-west-1 --api-module web --vpce $npm_package_security_vpce --account $npm_package_security_account --security-group-ids $npm_package_security_group --subnet-ids $npm_package_security_subnets"
+ },
+ "security": {
+ "account": "Your account number goes here",
+ "group": "Your security group ID goes here",
+ "vpce": "Your VPCE ID goes here",
+ "subnets": "Your subnet ID's go here"
+
+ },
+ "devDependencies": {
+ "claudia": "^4"
+ },
+ "dependencies": {
+ "claudia-api-builder": "^4"
+ }
+}

web-api-postdeploy-private-gateway/web.js

@@ -0,0 +1,43 @@
+/*global require, module*/
+var ApiBuilder = require('claudia-api-builder'),
+api = new ApiBuilder();
+
+module.exports = api;
+
+api.get('/', function () {
+'use strict';
+return 'Hello from your Private API';
+});
+
+api.addPostDeployStep('Update to Private', async function (options, lambdaDetails, utils) {
+'use strict';
+
+let policy = '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":"*","Action":"execute-api:Invoke","Resource":"arn:aws:execute-api:REGIONTEMPLATE:ACCOUNTTEMPLATE:APITEMPLATE/*","Condition":{"StringEquals":{"aws:sourceVpce":"VPCETEMPLATE"}}}]}';
+policy = policy.replace("ACCOUNTTEMPLATE",options.account);
+policy = policy.replace("APITEMPLATE",lambdaDetails.apiId);
+policy = policy.replace("REGIONTEMPLATE",lambdaDetails.region);
+policy = policy.replace("VPCETEMPLATE",options.vpce);
+
+let params = {
+restApiId: lambdaDetails.apiId,
+patchOperations: [
+//This patch will replace the existing policy with your policy above
+{
+op: 'replace',
+path: '/policy',
+value: policy
+},
+//This patch will update the API endpoint type from EDGE -> PRIVATE
+{
+op: 'replace',
+path: '/endpointConfiguration/types/EDGE',
+value :'PRIVATE'
+}
+]
+};
+await utils.apiGatewayPromise.updateRestApiPromise(params);
+
+
+await utils.apiGatewayPromise.createDeploymentPromise({restApiId: lambdaDetails.apiId, stageName: lambdaDetails.alias});
+});
+