本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 監控 API Gateway API 組態 AWS Config
<a name="apigateway-config"></a>

您可以使用 [AWS Config](https://aws.amazon.com/config/)，記錄對您的 API Gateway API 資源所做的組態變更，並根據資源變更傳送通知。保留 API Gateway 資源的組態變更歷史記錄很實用，可用於解決操作問題、稽核和合規使用案例。

AWS Config 可以追蹤下列項目的變更：
+ **API 階段組態**，例如：
  + 快取叢集設定
  + 調節設定
  + 存取日誌設定
  + 階段上使用中的部署設定
+ **API 組態**，例如：
  + 端點組態
  + version
  + 通訊協定
  + tags

此外， AWS Config 規則 此功能可讓您定義組態規則，並自動偵測、追蹤和提醒這些規則的違規情況。透過追蹤這些資源組態屬性的變更，您也可以為 API Gateway 資源撰寫變更觸發的 AWS Config 規則，並根據最佳實務測試資源組態。

您可以使用 AWS Config 主控台或 在 AWS Config 帳戶中啟用 AWS CLI。選取您要追蹤變更的資源類型。如果您先前已設定 AWS Config 記錄所有資源類型，則這些 API Gateway 資源會自動記錄在您的帳戶中。支援 中的 Amazon API Gateway AWS Config 適用於所有 AWS 公有區域和 AWS GovCloud (US)。如需受支援區域的完整清單，請參閱《 AWS 一般參考》中的 [Amazon API Gateway 端點和配額](https://docs.aws.amazon.com/general/latest/gr/apigateway.html)。

**Topics**
+ [支援的資源類型](#apigateway-config-resources-rules)
+ [設定 AWS Config](#apigateway-config-setup)
+ [設定 AWS Config 記錄 API Gateway 資源](#apigateway-config-configuring)
+ [在 AWS Config 主控台中檢視 API Gateway 組態詳細資訊](#apigateway-config-console)
+ [使用 AWS Config 規則評估 API Gateway 資源](#apigateway-config-rules)

## 支援的資源類型
<a name="apigateway-config-resources-rules"></a>

下列 API Gateway 資源類型與 整合， AWS Config 並記錄在[AWS Config 支援 AWS 的資源類型和資源關係](https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html)中：
+ `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 開發人員指南](https://docs.aws.amazon.com/config/latest/developerguide/)。如需定價資訊，請參閱[AWS Config 定價資訊頁面](https://aws.amazon.com/config/pricing/)。

**重要**  
如果您在部署 API 之後變更任何以下 API 屬性，則*必須*[重新部署](how-to-deploy-api.md) API 以傳播變更。否則，您會在 AWS Config 主控台中看到屬性變更，但先前的屬性設定仍然有效；API 的執行時間行為將保持不變。  
**`AWS::ApiGateway::RestApi`** – `binaryMediaTypes`, `minimumCompressionSize`, `apiKeySource`
**`AWS::ApiGatewayV2::Api`** – `apiKeySelectionExpression`

## 設定 AWS Config
<a name="apigateway-config-setup"></a>

若要最初設定 AWS Config，請參閱《 [AWS Config 開發人員指南](https://docs.aws.amazon.com/config/latest/developerguide/)》中的下列主題。
+ [AWS Config 使用主控台設定](https://docs.aws.amazon.com/config/latest/developerguide/gs-console.html)
+ [AWS Config 使用 設定 AWS CLI](https://docs.aws.amazon.com/config/latest/developerguide/gs-cli.html)

## 設定 AWS Config 記錄 API Gateway 資源
<a name="apigateway-config-configuring"></a>

根據預設， 會 AWS Config 記錄環境執行所在區域中探索的所有支援區域資源類型的組態變更。您可以自訂 AWS Config ，僅記錄特定資源類型的變更，或全域資源的變更。

若要了解區域資源與全域資源，並了解如何自訂您的 AWS Config 組態，請參閱[選取哪些資源 AWS Config 記錄](https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html)。

## 在 AWS Config 主控台中檢視 API Gateway 組態詳細資訊
<a name="apigateway-config-console"></a>

您可以使用 AWS Config 主控台來尋找 API Gateway 資源，並取得其組態的目前和歷史詳細資訊。以下程序顯示如何尋找 API Gateway API 的相關資訊。

**在 AWS 組態主控台中尋找 API Gateway 資源**

1. 開啟 [AWS Config 主控台](https://console.aws.amazon.com/config)。

1. 選擇 **Resources (資源)**。

1. 在 **Resource (資源)** 清單頁面上，選擇 **Resources (資源)**。

1. 開啟 **Resource type (資源類型)** 功能表，捲動到 APIGateway 或 APIGatewayV2，然後選擇一或多個 API Gateway 資源類型。

1. 選擇 **Look up** (查閱)。

1. 在 AWS Config 顯示的資源清單中選擇資源 ID。 AWS Config 會顯示組態詳細資訊，以及所選資源的其他資訊。

1. 若要查看記錄組態的完整詳細資訊，請選擇 **View Details (檢視詳細資訊)**。

若要進一步了解如何尋找資源並檢視此頁面的資訊，請參閱《 AWS Config 開發人員指南》中的[檢視 AWS 資源組態和歷史記錄](https://docs.aws.amazon.com/config/latest/developerguide/view-manage-resource.html)。

## 使用 AWS Config 規則評估 API Gateway 資源
<a name="apigateway-config-rules"></a>

您可以建立 AWS Config 規則，其代表 API Gateway 資源的理想組態設定。您可以使用預先定義的[AWS Config 受管規則](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html)，或定義自訂規則。 AWS Config 會持續追蹤資源組態的變更，以判斷這些變更是否違反規則中的任何條件。 AWS Config 主控台會顯示規則和資源的合規狀態。

如果資源違反規則並標記為不合規， AWS Config 可以使用 [Amazon Simple Notification Service 開發人員指南](https://docs.aws.amazon.com/sns/latest/dg/) (Amazon SNS) 主題提醒您。如要透過程式設計方式使用這些 AWS Config 提醒中的資料，請使用 Amazon Simple Queue Service (Amazon SQS) 佇列做為 Amazon SNS 主題的通知端點。

若要進一步了解設定及使用規則，請參閱 [AWS Config 開發人員指南](https://docs.aws.amazon.com/config/latest/developerguide/)中的[使用規則評估資源](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html)。