Monitoraggio della configurazione API di API Gateway con AWS Config - Amazon API Gateway

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Monitoraggio della configurazione API di API Gateway con AWS Config

Puoi usare AWS Config per registrare le modifiche di configurazione apportate alle risorse API Gateway API e inviare notifiche in base alle modifiche alle risorse. Conservare la cronologia delle modifiche eseguite sulla configurazione delle risorse di API Gateway è utile per la risoluzione dei problemi operativi, la revisione e i casi d'uso relativi alla conformità.

AWS Config è in grado di monitorare le modifiche apportate a:

  • Configurazione delle fasi API, ad esempio:

    • Impostazioni del cluster di cache

    • Impostazioni di throttling

    • Impostazioni dei log degli accessi

    • Set di distribuzione attivo nella fase

  • Configurazione dell'API, ad esempio:

    • Configurazione dell'endpoint

    • Versione

    • protocol

    • tags

Inoltre, la funzionalità Regole di AWS Config permette di definire regole di configurazione e rilevare, monitorare e comunicare tramite avvisi automaticamente eventuali violazioni a queste regole. La funzionalità di monitoraggio delle modifiche apportate alle proprietà di configurazione della risorsa consente, inoltre, di creare regole AWS Config attivate da modifiche per le risorse API Gateway e verificarne le configurazioni rispetto alle best practice.

Puoi abilitare AWS Config nell'account usando la console AWS Config o AWS CLI. Seleziona i tipi di risorsa per cui vuoi monitorare le modifiche. Se in precedenza hai configurato la registrazione di tutti i tipi di risorse su AWS Config, anche quelle di API Gateway verranno automaticamente registrate nel tuo account. Il supporto per Amazon API Gateway, nell'ambito del servizio AWS Config, è disponibile in tutte le Regioni pubbliche AWS e AWS GovCloud (US). Per l'elenco completo delle Regioni supportate, consulta Endpoint e quote Amazon API Gateway nei riferimenti generali Riferimenti generali di AWS.

Tipi di risorse supportati

I tipi di risorsa API Gateway seguenti sono integrati con AWS Config e vengono descritti in Tipi di risorse e relazioni tra risorse AWS supportati da AWS Config:

  • AWS::ApiGatewayV2::Api (API WebSocket e HTTP)

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

  • AWS::ApiGatewayV2::Stage (fase API WebSocket e HTTP)

  • AWS::ApiGateway::Stage (fase API REST)

Per ulteriori informazioni su AWS Config, consulta la Guida per lo sviluppatore di AWS Config. Per informazioni sui prezzi, consulta la pagina di informazioni sui prezzi di AWS Config.

Importante

Se modifichi una delle proprietà dell'API seguenti dopo avere distribuito l'API, devi ridistribuire l'API per propagare le modifiche. In caso contrario, le modifiche agli attributi verranno visualizzate nella console AWS Config, ma le impostazioni delle proprietà precedenti saranno ancora valide. il comportamento di runtime dell'API resterà invariato.

  • AWS::ApiGateway::RestApibinaryMediaTypes, minimumCompressionSize, apiKeySource

  • AWS::ApiGatewayV2::ApiapiKeySelectionExpression

Configurazione di AWS Config

Per la configurazione iniziale di AWS Config, consulta gli argomenti seguenti nella Guida per gli sviluppatori di AWS Config.

Configurazione di AWS Config per la registrazione delle risorse API Gateway

Per impostazione predefinita, AWS Config registra le modifiche di configurazione per tutti i tipi supportati di risorse regionali individuati nella regione in cui è in esecuzione l'ambiente. Puoi personalizzare AWS Config in modo da registrare le modifiche solo per tipi di risorse specifici oppure per le risorse globali.

Per informazioni sulle differenze tra risorse regionali e globali e su come personalizzare la configurazione di AWS Config, consulta la pagina relativa alla selezione delle risorse registrate da AWS Config.

Visualizzazione dei dettagli di configurazione di API Gateway nella console AWS Config

Puoi usare la console AWS Config per cercare le risorse API Gateway e ottenere informazioni correnti e cronologiche sulle loro configurazioni. La procedura seguente descrive come trovare informazioni su un'API di API Gateway.

Per trovare una risorsa API Gateway nella console di configurazione AWS
  1. Aprire la console AWS Config.

  2. Scegliere Resources (Risorse).

  3. Nella pagina Resource inventory (Inventario risorse), scegliere Resources (Risorse).

  4. Aprire il menu Resource type (Tipo di risorsa), scorrere fino ad APIGateway o APIGatewayV2 e quindi scegliere uno o più dei tipi di risorsa API Gateway.

  5. Scegliere Look up (Cerca).

  6. Scegliere un ID risorsa nell'elenco delle risorse visualizzate da AWS Config. AWS Config mostra i dettagli di configurazione e altre informazioni sulla risorsa selezionata.

  7. Per visualizzare i dettagli completi della configurazione registrata, scegliere View Details (Visualizza dettagli).

Per ulteriori informazioni su come trovare una risorsa e visualizzare le informazioni in questa pagina, consulta Visualizzazione delle configurazioni e della cronologia delle risorseAWS nella Guida per gli sviluppatori di AWS Config.

Valutazione delle risorse di API Gateway utilizzando le regole di AWS Config

Puoi creare regole di AWS Config, che rappresentano le impostazioni di configurazione ideali per le risorse API Gateway. Puoi usare regole gestite AWS Config predefinite oppure definire regole personalizzate. AWS Config monitora continuamente le modifiche apportate alla configurazione delle risorse per determinare se violino una o più delle condizioni nelle regole. La console AWS Config mostra lo stato di conformità delle regole e delle risorse.

Se una risorsa viola una regola e viene contrassegnata come non conforme, AWS Config può avvisare l'utente utilizzando un argomento Guida per gli sviluppatori di Amazon Simple Notification Service (Amazon SNS). Per utilizzare i dati a livello di programmazione in questi avvisi AWS Config, usa una coda Amazon Simple Queue Service (Amazon SQS) come l'endpoint di notifica per l'argomento Amazon SNS.

Per ulteriori informazioni sulla configurazione e l'uso di regole, consulta Valutazione delle risorse con le regole nella Guida per gli sviluppatori di AWS Config.