API Gateway API-Konfiguration mit überwache AWS Config

Sie können mit AWS Config Konfigurationsänderungen an Ihren API-Gateway-API-Ressourcen aufzeichnen und Benachrichtigungen auf der Grundlage von Ressourcenänderungen senden. Die Pflege eines Konfigurations-Änderungsverlaufs für API Gateway-Ressourcen ist nützlich bei Fehlerbehebung im Betrieb sowie Anwendungsfällen wie Audit und Compliance.

AWS Config kann folgende Änderungen nachverfolgen:

• API-Stufenkonfiguration, wie z. B.:

  • Cache-Cluster-Einstellungen

  • Drosselungseinstellungen

  • Zugriffsprotokolleinstellungen

  • aktive Bereitstellung, die für die Stufe festgelegt wurde

• API-Konfiguration, wie z. B.:

  • Endpunktkonfiguration

  • Version

  • Protokoll

  • Tags

Darüber hinaus können Sie mit der AWS-Config-Regeln-Funktion Konfigurationsregeln definieren und Verstöße gegen diese Regeln automatisch erkennen, nachverfolgen und melden. Indem Sie die Änderungen an diesen Ressourcen-Konfigurationseigenschaften nachverfolgen, können Sie auch durch Änderungen ausgelöste AWS Config-Regeln für Ihre API-Gateway-Ressourcen erstellen und Ihre Ressourcen-Konfigurationen für bewährte Methoden testen.

Sie können AWS Config in Ihrem Konto mithilfe der AWS Config-Konsole oder der AWS CLI aktivieren. Wählen Sie die Ressourcentypen aus, für die Sie Änderungen nachverfolgen möchten. Wenn Sie AWS Config zuvor so konfiguriert haben, dass alle Ressourcentypen aufgezeichnet werden, dann werden diese API-Gateway-Ressourcen automatisch in Ihrem Konto aufgezeichnet. Die Unterstützung für Amazon API Gateway in AWS Config ist in allen öffentlichen AWS-Regionen und in AWS GovCloud (US) verfügbar. Die vollständige Liste der unterstützten Regionen finden Sie unter Amazon-API-Gateway-Endpunkte und -Kontingente in der Allgemeine AWS-Referenz.

Unterstützte Ressourcentypen

Die folgenden API-Gateway-Ressourcentypen sind in AWS Config integriert und im Abschnitt Von AWS Config unterstützte AWS-Ressourcentypen und -beziehungen dokumentiert:

• AWS::ApiGatewayV2::Api (WebSocket- und HTTP-API)

• AWS::ApiGateway::RestApi (REST-API)

• AWS::ApiGatewayV2::Stage (WebSocket- und HTTP-API-Stufe)

• AWS::ApiGateway::Stage (REST-API-Stufe)

Weitere Informationen über AWS Config finden Sie im AWS Config-Entwicklerhandbuch. Preise finden Sie auf der Seite mit Preisinformationen zu AWS Config.

Wichtig

Wenn Sie eine der folgenden API-Eigenschaften nach Bereitstellung der API ändern, müssen Sie die API erneut bereitstellen, um die Änderungen zu übernehmen. Andernfalls sehen Sie zwar die Attributänderungen in der AWS Config-Konsole, die vorherigen Eigenschaftseinstellungen sind jedoch weiterhin wirksam. Das Laufzeitverhalten der API ist unverändert.

• AWS::ApiGateway::RestApi – binaryMediaTypes, minimumCompressionSize, apiKeySource

• AWS::ApiGatewayV2::Api – apiKeySelectionExpression

Einrichten von AWS Config

Die Ersteinrichtung von AWS Config wird in den folgenden Themen im AWS Config-Entwicklerhandbuch beschrieben.

• Einrichten von AWS Config mit der Konsole

• Einrichten von AWS Config mit der AWS CLI

Konfigurieren von AWS Config zur Aufzeichnung von API-Gateway-Ressourcen

Standardmäßig zeichnet AWS Config die Konfigurationsänderungen für alle unterstützten Typen von regionalen Ressourcen auf, die in der Region erkannt werden, in der die Umgebung ausgeführt wird. Sie können AWS Config so anpassen, dass Änderungen nur für bestimmte Ressourcentypen oder nur Änderungen an globalen Ressourcen aufgezeichnet werden.

Informationen über regionale im Unterschied zu globalen Ressourcen sowie zum Anpassen der AWS Config-Konfiguration finden Sie unter Auswählen der Ressourcen, die AWS Config aufzeichnet.

Anzeigen von API-Gateway-Konfigurationsdetails in der AWS Config-Konsole

Sie können die AWS Config-Konsole verwenden, um nach API-Gateway-Ressourcen zu suchen und aktuelle und historische Details über deren Konfigurationen zu erhalten. Die folgende Prozedur zeigt, wie Sie Informationen über eine API Gateway-API finden.

So finden Sie eine API-Gateway-Ressource in der AWS-Konfigurationskonsole

1. Öffnen Sie die AWS Config-Konsole.

2. Wählen Sie Resources aus.

3. Wählen Sie auf der Seite Resource inventory (Ressourcenbestand) die Option Resources (Ressourcen) aus.

4. Öffnen Sie das Menü Resource type (Ressourcentyp), blättern Sie zu APIGateway oder APIGatewayV2 und wählen Sie dann einen oder mehrere der API Gateway-Ressourcentypen.

5. Wählen Sie Look up.

6. Wählen Sie in der Liste der Ressourcen, die von AWS Config angezeigt wird, eine Ressource-ID aus. AWS Config zeigt Konfigurationsdetails und andere Informationen über die Ressource, die Sie ausgewählt haben.

7. Die vollständigen Details der aufgezeichneten Konfiguration können Sie mit View Details (Details anzeigen) anzeigen.

Weitere Möglichkeiten zum Suchen einer Ressource und zum Anzeigen von Informationen auf dieser Seite finden Sie unter Anzeigen von AWS-Ressourcenkonfigurationen und -verlauf im AWS Config-Entwicklerhandbuch.

Bewertung von API-Gateway-Ressourcen mithilfe von AWS Config-Regeln

Sie können AWS Config-Regeln erstellen, die die idealen Konfigurationseinstellungen für Ihre API-Gateway-Ressourcen darstellen. Sie können vordefinierte Verwaltete AWS Config-Regeln verwenden oder benutzerdefinierte Regeln definieren. AWS Config verfolgt kontinuierlich Änderungen an der Konfiguration Ihrer Ressourcen, um zu bestimmen, ob diese Änderungen gegen eine Bedingung Ihrer Regeln verstoßen. Die AWS Config-Konsole zeigt den Compliance-Status Ihrer Regeln und Ressourcen an.

Wenn eine Ressource gegen eine Regel verstößt und als nicht konform gekennzeichnet wird, kann AWS Config Sie mithilfe eines Amazon-SNS-Themas Entwicklerhandbuch zu Amazon Simple Notification Service warnen. Um die Daten in diesen AWS ConfigWarnungen programmgesteuert zu nutzen, verwenden Sie eine Amazon-SQS-Warteschlange (Amazon Simple Queue Service) als Benachrichtigungsendpunkt für das Amazon-SNS-Thema.

Weitere Informationen zum Einrichten und Verwenden von Regeln finden Sie unter Ressourcen mit Regeln auswerten im AWS Config-Entwicklerhandbuch.