Amazon API Gateway

Managed REST, HTTP and WebSocket API front door.

Provider: aws
Kind: API gateway
Category: Edge
Official docs: https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html

Properties · 3 set by this component

property	type	values	required	kind default	this component
apiType · component property	enum	rest \| http \| websocket	no	http	inherited
auth	enum	none \| api-key \| jwt \| oauth2 \| mtls	no	none	inherited
concurrencyLimit	boolean	—	no	false	inherited
idempotencyKeys · advanced	boolean	—	no	false	▸ false
instances	integer	—	no	—	inherited
keyTtlHours · advanced	integer	—	no	—	inherited
managed	boolean	—	no	false	inherited
protocol	enum	http \| grpc \| websocket \| fix \| ouch	no	http	inherited
rateLimiting	boolean	—	no	false	▸ true
tls	boolean	—	no	true	▸ true

Rules that apply · 1

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Synchronous call chain too deepwarning

sync-chain-too-deep

Every consecutive synchronous hop from this entry point spends part of the stated p95 latency budget, and the chain's failures multiply. More than three hops is a budget nobody is tracking.

— all of these hold:
— the design requirement `latency.p95Ms` has a value
— the longest chain of synchronous calls starting at the node is more than 3 hops long

Use it in a design

nodes:
  - { id: "api-gateway", component: "aws-api-gateway" }

Other API gateway products · 40

API Gatewayalibaba-api-gatewayalibabacloudapi-gateway AWS AppSync GraphQL APIaws-appsyncawsapi-gateway Azure API Managementazure-api-managementazureapi-gateway AI Gatewaycloudflare-ai-gatewaycloudflareapi-gateway Cloudflare API Shieldcloudflare-api-shieldcloudflareapi-gateway MCP Server Portalcloudflare-mcp-portalcloudflareapi-gateway Cloudflare Privacy Gatewaycloudflare-privacy-gatewaycloudflareapi-gateway Generic API gatewayapi-gatewayapi-gateway Apache APISIXapisixapi-gateway Apollo GraphOSapollo-graphosapi-gateway Easegresseasegressapi-gateway Emissary-ingressemissaryapi-gateway Envoy Gatewayenvoy-gatewayapi-gateway Gloo Gatewayglooapi-gateway Hasurahasuraapi-gateway Helicone AI Gatewayhelicone-gatewayapi-gateway Higresshigressapi-gateway Kong Gatewaykongapi-gateway Kong AI Gatewaykong-ai-gatewayapi-gateway Kong Konnectkong-konnectapi-gateway KrakenDkrakendapi-gateway LiteLLM Proxylitellmapi-gateway Martian Gatewaymartianapi-gateway Not Diamondnot-diamondapi-gateway Portkey AI Gatewayportkeyapi-gateway Requestyrequestyapi-gateway Spring Cloud Gatewayspring-cloud-gatewayapi-gateway Tyk Gatewaytykapi-gateway Unifyunify-aiapi-gateway Vercel AI Gatewayvercel-ai-gatewayapi-gateway WSO2 API Managerwso2-api-managerapi-gateway Zuulzuulapi-gateway Apigeeapigeegcpapi-gateway Agent Gatewaygoogle-agent-gatewaygcpapi-gateway API Gatewaygoogle-api-gatewaygcpapi-gateway Apigee hybridgoogle-apigee-hybridgcpapi-gateway Cloud Endpointsgoogle-cloud-endpointsgcpapi-gateway Firebase Data Connectgoogle-firebase-data-connectgcpapi-gateway IBM API Connectibm-api-connectibmapi-gateway OCI API Gatewayoci-api-gatewayociapi-gateway

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Amazon API Gateway: managed REST/HTTP/WebSocket API front door. Rate limiting via usage plans is on by account throttling; idempotency keys are not built in.
3schemaVersion: "1"
4type: "component"
5id: "aws-api-gateway"
6kind: "api-gateway"
7provider: "aws"
8docs: "https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html"
9defaults:
10  tls: true
11  rateLimiting: true
12  idempotencyKeys: false
13properties:
14  apiType:
15    type: "enum"
16    values: ["rest", "http", "websocket"]
17    default: "http"

The same page as markdown, for an agent: /catalogue/components/aws-api-gateway.md