Cache APIGateway Response with CloudFront
Zusammenfassung
Kurz
Der Artikel erklärt, wie eine API-Gateway-REST-API über CloudFront gecacht werden kann: Nach der Einrichtung von Lambda und API wird in der Distribution eine Cache Policy aktiviert, da die Standardeinstellung laut Autor Caching deaktiviert. Der Autor beschreibt außerdem einen einfachen Test mit einer zeitabhängigen Antwort, das Weiterleiten eines `X-API-Key`-Headers und Cache-Invalidierungen über API oder Konsole.
Mittel
Der Artikel zeigt anhand einer Lambda-Funktion mit zeitabhängiger Antwort, wie sich API-Gateway-Antworten über CloudFront cachen lassen. Zunächst wird eine REST-API eingerichtet, mit Lambda verbunden und in einer Stage bereitgestellt. Anschließend erstellt man eine CloudFront-Distribution mit API Gateway als Ursprung. Den Namen der Stage trägt man entweder als Origin Path ein oder hängt ihn beim Aufruf an die Distributionsadresse an.
Laut Artikel ist das Caching in den empfohlenen Standard-Ursprungseinstellungen zunächst deaktiviert. Deshalb soll die Cache Policy im Verhalten der Distribution etwa auf „CachingOptimized“ oder „UseOriginCacheControlHeaders“ umgestellt werden; auch eine eigene Policy sei möglich. Nach Aktivierung der Distribution lässt sich das Caching durch wiederholte Aufrufe und den Vergleich der Zeitangabe prüfen. Ein `Cache-Control`-Header könne die gewünschte Dauer festlegen.
Der Autor behauptet, dass ein API-Schlüssel ohne weitere Änderungen über `X-API-Key` mitgesendet werden kann, weil die Standard-Origin-Request-Policy alle Viewer-Parameter außer dem Host-Header weiterleite. Für Cache-Invalidierungen nennt er die CloudFront-API oder die Konsole. Eine umfassende Bewertung der Konfigurationen bietet der Artikel nicht.
Ausführlich lesen
Der Artikel beschreibt, wie sich Antworten einer REST-API in Amazon API Gateway über CloudFront zwischenspeichern lassen. Der Autor nennt als mögliche Gründe für CloudFront unter anderem die Annahme von HTTP-Anfragen, Unterstützung älterer SSL-/TLS-Versionen, die Einbindung von WAF, genauer einstellbare Cache-Regeln und die Möglichkeit, den Cache gezielt zu invalidieren. Der Text stellt diese Gründe als Einsatzszenarien dar; er vergleicht sie nicht im Detail mit dem API-Gateway-eigenen Caching.
Als Beispiel dient eine Lambda-Funktion, die mit jeder Antwort eine aktuelle Zeitangabe ausgibt. So soll sich beim wiederholten Aufruf erkennen lassen, ob eine Antwort aus dem Cache kommt. Der Artikel führt anschließend durch die Einrichtung einer REST-API in API Gateway: Die API wird erstellt, eine Methode mit Lambda als Integration angelegt und in einer neuen Stage bereitgestellt. Ein erster Aufruf der API-URL soll bestätigen, dass die Funktion die erwartete Antwort liefert.
Danach wird eine CloudFront-Distribution mit API Gateway als Ursprung angelegt. Den Namen der API-Stage kann man laut Anleitung entweder mit führendem Schrägstrich als Origin Path eintragen oder beim Aufruf an die Distributionsadresse anhängen. Der Autor empfiehlt zunächst die vorgegebenen Ursprungseinstellungen. Er weist darauf hin, dass die standardmäßige Cache Policy für API-Gateway-Ursprünge auf „CachingDisabled“ steht. Nach dem Erstellen der Distribution soll man deshalb im Tab „Behaviors“ die Cache Policy ändern. Als Beispiel nennt der Artikel „CachingOptimized“; alternativ werden „UseOriginCacheControlHeaders“ und eine selbst erstellte Policy erwähnt. WAF könne bei Bedarf aktiviert werden.
Sobald der Status der Distribution „Enabled“ ist, soll man deren Domainnamen aufrufen, gegebenenfalls ergänzt um den Stage-Namen. Mehrere Aufrufe sollen zeigen, ob die Zeitangabe gleich bleibt. Der Artikel schlägt außerdem vor, bei Bedarf einen „Cache-Control“-Header wie `max-age=604800` zu setzen. Das beschriebene Prüfverfahren ist ein einfaches Beispiel mit einer zeitabhängigen Lambda-Antwort; der Bericht enthält keine Messwerte oder systematische Leistungsbewertung.
Für APIs mit Authentifizierungsheadern, etwa einem API-Schlüssel, behauptet der Autor, seien keine zusätzlichen Änderungen nötig: Der Header `X-API-Key` könne beim Aufruf der CloudFront-Distribution mitgesendet werden. Als Begründung nennt er die standardmäßig verwendete Origin Request Policy „AllViewerExceptHostHeader“, die dem Artikel zufolge alle Parameter der Viewer-Anfrage außer dem Host-Header weiterleitet. Abschließend verweist der Autor für CDK auf einen früheren Beitrag und erklärt, dass sich eine Cache-Invalidierung über die CloudFront-API `create_invalidation` oder über die Konsole auslösen lasse. Nicht näher ausgeführt werden etwa konkrete Policy-Konfigurationen für individuelle Anforderungen oder die Auswirkungen verschiedener Cache-Einstellungen auf einzelne API-Szenarien.
Gegengeprüft von Claude Haiku 5.5: kleine Mängel
Es wurden keine Fragen angegeben (Lunas Einordnung je Sammelfrage und je Teilfrage ist leer), daher gibt es keine Einordnung. Die Zusammenfassungen sind inhaltlich treu; in allen Fassungen fehlt die Liste der Szenarien für CloudFront, und die Zusammenfassung ist durchgängig korrekt.
Im Bericht, aber nicht in der Zusammenfassung
- Die im Artikel genannten Szenarien, in denen CloudFront statt eines reinen API-Gateway-Caches sinnvoll ist: HTTP-Anfragen, ältere SSL/TLS-Versionen, WAF, detailliertere Cache-Einstellungen und die Möglichkeit zur Cache-Invalidierung
- Der Verweis des Autors auf eigene frühere Artikel (CDK-Stack, Invalidierung bei S3-Upload) als weiterführende Hinweise
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.