로 API Gateway API 구성 모니터링AWS Config - Amazon API Gateway
지원되는 리소스 유형 설정AWS ConfigAPI Gateway 리소스를 기록하도록 AWS Config 구성AWS Config 콘솔에서 API Gateway 구성 세부 정보 보기AWS Config 규칙을 사용하여 API Gateway 리소스 평가

로 API Gateway API 구성 모니터링AWS Config

AWS Config를 사용하여 API Gateway API 리소스에 대한 구성 변경을 기록하고, 리소스 변경을 기반으로 알림을 보낼 수 있습니다. API Gateway 리소스에 대한 구성 변경 기록을 유지 관리하면 운영 문제 해결, 감사 및 규정 준수 사용 사례에 도움이 됩니다.

AWS Config는 다음에 대한 변경을 추적할 수 있습니다.

  • 다음과 같은 API 단계 구성

    • 캐시 클러스터 설정

    • 스로틀 설정

    • 액세스 로그 설정

    • 단계의 활성 배포 세트

  • 다음과 같은 API 구성

    • 엔드포인트 구성

    • version

    • protocol

    • tags

또한 AWS Config 규칙 기능을 사용하여 구성 규칙을 정의하고, 이러한 규칙에 대한 위반을 자동으로 감지 및 추적하고 알릴 수 있습니다. 이러한 리소스 구성 속성의 변경 사항을 추적하면 API Gateway 리소스에 대해 변경으로 트리거되는 AWS Config 규칙을 작성하고, 모범 사례를 기준으로 리소스 구성을 테스트할 수도 있습니다.

계정에서 AWS Config 콘솔 또는 AWS Config를 사용하여 AWS CLI를 활성화할 수 있습니다. 그런 다음 변경 사항을 추적하려는 리소스 유형을 선택합니다. 이전에 구성한 AWS Config가 모든 리소스 유형을 기록하는 경우 이러한 API Gateway 리소스가 계정에 자동으로 기록됩니다. AWS Config의 Amazon API Gateway에 대한 지원은 모든 AWS 퍼블릭 리전 및 AWS GovCloud (US)에서 사용할 수 있습니다. 지원되는 리전의 전체 목록은 AWS 일반 참조에서 Amazon API Gateway 엔드포인트 및 할당량을 참조하세요.

지원되는 리소스 유형

다음 API Gateway 리소스 유형은 AWS Config와 통합되며, AWS Config 지원 AWS 리소스 유형과 리소스 관계에서 설명합니다.

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

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

  • AWS::ApiGatewayV2::Stage(WebSocket 및 HTTP API 단계)

  • AWS::ApiGateway::Stage(REST API 단계)

AWS Config에 대한 자세한 내용은 AWS Config개발자 안내서 단원을 참조하십시오. 요금에 대한 자세한 내용은 AWS Config 요금 정보 페이지를 참조하십시오.

중요

API를 배포한 후 다음과 같은 API 속성을 변경한 경우, 반드시 API를 재배포하여 변경을 전파해야 합니다. 이렇게 하지 않으면 AWS Config 콘솔에서는 속성 변경이 표시되지만, 이전 속성 설정이 여전히 유효하며 API의 런타임 동작이 변경되지 않습니다.

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

  • AWS::ApiGatewayV2::Api – apiKeySelectionExpression

설정AWS Config

처음 AWS Config를 설정한다면 AWS Config 개발자 안내서의 다음 주제를 참조하세요.

API Gateway 리소스를 기록하도록 AWS Config 구성

기본적으로 AWS Config는 해당 환경이 실행 중인 리전에서 검색하는 지원되는 모든 유형의 리전 리소스에 대한 구성 변경을 기록합니다. 특정 리소스 유형만의 변경 또는 글로벌 리소스 변경을 기록하도록 AWS Config를 사용자 지정할 수 있습니다.

리전 리소스와 글로벌 리소스를 확인하고 AWS Config 구성을 사용자 지정하는 방법을 알아보려면 AWS Config가 기록할 리소스 선택을 참조하십시오.

AWS Config 콘솔에서 API Gateway 구성 세부 정보 보기

AWS Config 콘솔을 사용해 API Gateway 리소스를 찾고, 현재 및 과거 구성에 대한 세부 정보를 얻을 수 있습니다. 다음 절차는 API Gateway API에 대한 정보를 찾는 방법을 보여 줍니다.

AWS config 콘솔에서 API Gateway 리소스 찾기

  1. AWS Config 콘솔을 엽니다.

  2. 리소스를 선택합니다.

  3. 리소스 인벤토리 페이지에서 리소스를 선택합니다.

  4. 리소스 유형(Resource type) 메뉴를 열고 APIGateway 또는 APIGatewayV2로 스크롤 한 후 API Gateway 리소스 유형 중 하나 이상을 선택합니다.

  5. Look up(조회)을 선택합니다.

  6. AWS Config가 표시할 리소스 목록의 리소스 ID를 선택합니다. AWS Config는 선택한 리소스에 대한 구성의 세부 정보와 기타 정보를 표시합니다.

  7. 기록이 된 구성의 세부 정보를 완전히 확인하려면 세부 정보 보기를 선택합니다.

이 페이지의 리소스 및 보기 정보를 찾는 방법에 대한 자세한 내용은 AWS Config 개발자 안내서의 AWS 리소스 구성 및 기록 보기를 참조하세요.

AWS Config 규칙을 사용하여 API Gateway 리소스 평가

API Gateway 리소스에 대한 이상적인 구성 설정을 나타내는 AWS Config 규칙을 생성할 수 있습니다. 미리 정의된 AWS Config 관리형 규칙을 사용하거나, 사용자 지정 규칙을 정의할 수 있습니다. AWS Config는 사용자 리소스의 구성을 계속 추적해 변경 사항이 사용자 규칙의 조건을 위반하는지 여부를 결정합니다. AWS Config 콘솔에는 규칙과 리소스의 준수 상태가 표시됩니다.

리소스가 규칙을 위반하고 규정 위반으로 플래그가 지정된 경우 AWS Config에서는 Amazon Simple Notification Service 개발자 안내서(Amazon SNS) 주제를 사용하여 알림을 제공할 수 있습니다. 이러한 AWS Config 알림의 데이터를 프로그래밍 방식으로 사용하려면 Amazon Simple Queue Service(Amazon SQS) 대기열을 Amazon SNS 주제의 알림 엔드포인트로 사용합니다.

규칙 설정 및 사용에 대한 자세한 내용은 AWS Config 개발자 안내서의 규칙으로 리소스 평가를 참조하세요.