Monitoreo de la configuración de la API de API Gateway con AWS Config
Puede utilizar AWS Config
AWS Config puede realizar el seguimiento de cambios realizados en:
-
Configuración de etapas de la API, como por ejemplo:
-
configuración del clúster de caché
-
configuración de restricción
-
configuración del registro de acceso
-
la implementación activa definida en la etapa
-
-
Configuración de la API, como por ejemplo:
-
configuración de punto de enlace
-
versión
-
protocolo
-
etiquetas
-
Además, la característica Reglas de AWS Config le permite definir las reglas de configuración y detectar automáticamente, realizar el seguimiento y alertar cuando se infringen esas reglas. Mediante el seguimiento de los cambios realizados a las propiedades de la configuración de recursos, también puede crear reglas de AWS Config activadas por cambios para los recursos de API Gateway y probar las configuraciones de recursos en función de las prácticas recomendadas.
Puede habilitar AWS Config en su cuenta mediante la consola de AWS Config o la AWS CLI. Seleccione los tipos de recursos en los cuales quiere realizar el seguimiento de los cambios. Si anteriormente estableció la configuración para que AWS Config registrara todos los tipos de recursos, esos recursos de API Gateway se registran de forma automática en la cuenta. El soporte para Amazon API Gateway en AWS Config está disponible en todas las regiones públicas AWS y AWS GovCloud (US). Para ver la lista completa de las regiones admitidas, consulte Puntos de conexión y cuotas de Amazon API Gateway en la Referencia general de AWS.
Temas
Tipos de recursos admitidos
Los siguientes tipos de recursos de API Gateway se integran con AWS Config y se documentan en Tipos de recursos de AWS Config admitidos por AWS y relaciones de recursos:
-
AWS::ApiGatewayV2::Api(WebSocket y API HTTP) -
AWS::ApiGateway::RestApi(API REST) -
AWS::ApiGatewayV2::Stage(WebSocket y etapa de API HTTP) -
AWS::ApiGateway::Stage(Etapa de API de REST)
Para obtener más información sobre AWS Config, consulte la Guía para desarrolladores de AWS Config. Para obtener información acerca de los precios, consulte la página de información sobre precios de AWS Config
importante
Si cambia cualquiera de las siguientes propiedades de API una vez que se implementa la API, es necesario volver a implementar la API para propagar los cambios. De lo contrario, verá los cambios de atributo en la consola de AWS Config, pero la configuración de la propiedad anterior seguirá estando en vigor; el comportamiento de tiempo de ejecución de la API permanecerá inalterado.
-
AWS::ApiGateway::RestApi–binaryMediaTypes,minimumCompressionSize,apiKeySource -
AWS::ApiGatewayV2::Api–apiKeySelectionExpression
Configuración de AWS Config
Para configurar AWS Config inicialmente, consulte los temas siguientes en la Guía de desarrollador de AWS Config.
Configuración AWS Config para registrar recursos de API Gateway
De forma predeterminada, AWS Config registra los cambios de configuración de todos los tipos de recursos regionales admitidos que descubre en la región en la que se ejecuta el entorno. Puede personalizar AWS Config de forma que únicamente registre los cambios de determinados tipos de recursos o los cambios de los recursos globales.
Para obtener más información acerca de los recursos regionales y globales, así como el procedimiento de personalización de la configuración de AWS Config, consulte Selección de los recursos que debe registrar AWS Config.
Visualización de los detalles de configuración de API Gateway en la consola de AWS Config
Puede utilizar la consola de AWS Config para buscar recursos de API Gateway y obtener datos actuales e históricos sobre sus configuraciones. El siguiente procedimiento muestra cómo buscar información sobre una API de API Gateway.
Para buscar un recurso de API Gateway en la consola de AWS Config
-
Abra la consola de AWS Config
. -
Elija Resources (Recursos).
-
En la página Resource inventory, elija Resources.
-
Abra el menú Resource type (Tipo de recurso), vaya a APIGateway o APIGatewayV2 y elija uno o varios tipos de recursos de API Gateway.
-
Elija Look up (Buscar).
-
Elija un ID de recurso en la lista de recursos que muestra AWS Config. AWS Config muestra detalles de configuración y otra información sobre el recurso que ha seleccionado.
-
Para ver todos los detalles de la configuración registrada, elija View Details (Ver detalles).
Para conocer otras maneras de buscar un recurso y ver información en esta página, consulte Visualización de historial y configuraciones de recursos de AWS en la Guía del desarrollador de AWS Config.
Evaluación de recursos de API Gateway mediante las reglas de AWS Config
Puede crear reglas de AWS Config que representarán la configuración ideal para sus recursos de API Gateway. Puede utilizar reglas administradas de AWS Config o definir reglas personalizadas. AWS Config realiza un seguimiento constante de los cambios de configuración de los recursos para determinar si estos cambios infringen cualquiera de las condiciones de las reglas. La consola de AWS Config muestra el estado de conformidad de sus reglas y recursos.
Si un recurso infringe una regla y está marcado como no conforme, AWS Config puede avisarle mediante un tema de la Guía de desarrollador de Amazon Simple Notification Service (Amazon SNS). Para consumir mediante programación los datos de estas alertas de AWS Config, utilice una cola de Amazon Simple Queue Service (Amazon SQS) como punto de enlace de notificación para el tema Amazon SNS.
Para obtener más información acerca de cómo configurar y utilizar reglas, consulte Evaluación de recursos con reglas en la Guía para desarrolladores de AWS Config.
