DEV Community


Posted on • Originally published at

AWS API Gateway Cheat Sheet

Image description

  • Deployment - point-in-time snapshot of your API Gateway API
  • Endpoint -

    • Edge-optimized
    • Private
    • Regional
    • Stage - A logical reference to a lifecycle state of your API.
    • Route - URL path, Latency based routing,
    • Integration - Lambda, HTTP, Private VPC, CORS
    • Import/Export - Open API
    • AM User should have permission to enable logging
  • Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale.

  • Stage variables are name-value pairs that you can define as configuration attributes associated with a deployment stage of a REST API. The act like environment variables and can be used in your API setup and mapping templates.

  • With deployment stages in API Gateway you can manage multiple release stages for each API, such as: alpha, beta, and production. Using stage variables you can configure an API deployment stage to interact with different backend endpoints.

  • When you build an API Gateway API with standard Lambda integration using the API Gateway console, the console automatically adds the required permissions. However, when you set up a stage variable to call a Lambda function through our API, you must manually add these permissions.

  • Integration timeout for AWS, Lambda, Lambda proxy, HTTP, HTTP proxy - 50 ms to 29 seconds

  • You can enable API caching to cache your endpoint's responses, this reduces the number of calls made to your endpoint and improves the latency of requests to your API

  • AWS Gateway Integration types:

    • AWS_ Proxy - lambda proxy integration
    • HTTP - http custom integration
    • HTTP_PROXY - http proxy

Top comments (0)