Best Practices for Designing Amazon API Gateway Private APIs and Private Integration - Best Practices for Designing Amazon API Gateway Private APIs and Private Integration

Best Practices for Designing Amazon API Gateway Private APIs and Private Integration

Publication date: January 12, 2021 (Document history)

Abstract

For many enterprise customers, AWS Direct Connect or a virtual private network (VPN) is often used to build a network connection between an on-premises network and an Amazon Web Services (AWS) virtual private cloud (VPC). This adds additional complexity to a network design, and introduces challenges to Amazon API Gateway private API and private integration setup. This whitepaper introduces best practices for deploying private APIs and private integrations in API Gateway, and discusses security, usability, and architecture.

This whitepaper is aimed at developers who use API Gateway, or are considering using it in the future.