Monitorar a configuração da API do API Gateway com AWS Config
Você pode usar o AWS Config
AWS ConfigO pode rastrear alterações em:
-
Configuração de estágio de API, como:
-
configurações de cluster de cache
-
configurações de limites
-
configurações de logs de acesso
-
a implantação ativa definida no estágio
-
-
Configuração de API, como:
-
configuração do endpoint
-
versão
-
protocolo
-
tags
-
Além disso, o recurso do Regras do AWS Config permite que você defina regras de configuração e detecte, rastreie e alerte violações dessas regras automaticamente. Além disso, o rastreamento de alterações nessas propriedades de configuração de recursos permite criar regras do AWS Config acionadas por alterações para recursos do API Gateway e testar as configurações de recursos em relação às melhores práticas.
Você pode habilitar o AWS Config em sua conta usando o console do AWS Config ou a AWS CLI. Selecione os tipos de recurso para os quais você deseja rastrear as alterações. Se você já configurou o AWS Config para registrar todos os tipos de recursos, esses recursos do API Gateway serão registrados automaticamente na sua conta. O suporte ao Amazon API Gateway em AWS Config está disponível em todas as regiões públicas da AWS e em AWS GovCloud (US). Para obter a lista completa de regiões compatíveis, consulte Endpoints e cotas do Amazon API Gateway na Referência geral da AWS.
Tópicos
Tipos de recursos compatíveis
Os seguintes tipos de recursos do API Gateway são integrados ao AWS Config e documentados em Relacionamentos de recursos e tipos de recursos da AWS com suporte do AWS Config:
-
AWS::ApiGatewayV2::Api(WebSocket e API HTTP) -
AWS::ApiGateway::RestApi(API REST) -
AWS::ApiGatewayV2::Stage(estágio de API WebSocket e HTTP) -
AWS::ApiGateway::Stage(Estágio de API REST)
Para obter mais informações sobre o AWS Config, consulte o Guia do desenvolvedor do AWS Config. Para obter informações sobre a definição de preço, consulte a página de informações sobre a definição de preço do AWS Config
Importante
Se você alterar qualquer uma das seguintes propriedades da API depois que a API for implantada, deverá reimplantá-la para propagar as alterações. Caso contrário, você verá as alterações de atributo no console do AWS Config, mas as configurações de propriedade anteriores ainda estarão em vigor. O comportamento de tempo de execução da API permanecerá inalterado.
-
AWS::ApiGateway::RestApi–binaryMediaTypes,minimumCompressionSize,apiKeySource -
AWS::ApiGatewayV2::Api–apiKeySelectionExpression
Configurar o AWS Config
Para fazer a configuração inicial do AWS Config, consulte os tópicos a seguir no Guia do desenvolvedor do AWS Config.
Configuração do AWS Config para registrar recursos do API Gateway
Por padrão, o AWS Config registra as alterações de configuração para todos os tipos de recursos regionais com suporte, que ele descobre na região em que seu ambiento está sendo executado. Você pode personalizar o AWS Config para registrar alterações somente para tipos de recursos específicos ou alterações em recursos globais.
Para saber mais sobre os recursos regionais versus globais e saber como personalizar sua configuração do AWS Config, consulte Selecionar quais recursos o AWS Config registra.
Vizualização de detalhes de configuração do API Gateway no console do AWS Config
É possível usar o console do AWS Config para procurar recursos do API Gateway atuais e históricos e obter detalhes sobre suas configurações. O procedimento a seguir mostra como encontrar informações sobre uma API do API Gateway.
Como localizar um recurso do API Gateway no console de configuração do AWS
-
Abra o console do AWS Config
. -
Escolha Resources (Recursos).
-
Na página de inventário Resource (Recurso), selecione Resources (Recursos).
-
Abra o menu Resource type (Tipo de recurso), role a tela até APIGateway ou APIGatewayV2 e selecione um ou mais tipos de recursos do API Gateway.
-
Escolha Look up.
-
Selecione um ID de recurso na lista de recursos que o AWS Config exibe. O AWS Config exibe detalhes de configuração e outras informações sobre o recurso que você selecionou.
-
Para ver os detalhes completos da configuração registrada, selecione View Details (Exibir detalhes).
Para saber mais maneiras de localizar um recurso e exibir informações nesta página, consulte Visualizar configurações de recursos e histórico da AWS no Guia do desenvolvedor do AWS Config.
Avaliação de recursos do API Gateway usando regras do AWS Config
É possível criar regras do AWS Config que representam as definições de configuração ideais para seus recursos do API Gateway. Você pode usar Regras de configuração gerenciadas pelo AWS Config predefinidas ou definir regras personalizadas. O AWS Config monitora de forma contínua as alterações na configuração dos seus recursos para determinar se essas alterações violam alguma condição em suas regras. O console AWS Config mostra o status de compatibilidade de suas regras e recursos.
Se um recurso violar uma regra e for sinalizado como não compatível, o AWS Config poderá alertá-lo usando um tópico do Guia do desenvolvedor do Amazon Simple Notification (Amazon SNS). Para consumir programaticamente os dados nesses alertas do AWS Config, use uma fila do Amazon Simple Queue Service (Amazon SQS) como o endpoint de notificação para o tópico do Amazon SNS.
Para saber mais sobre como configurar e usar regras, consulte Avaliação de recursos com regras no Guia do desenvolvedor do AWS Config.
