AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

API 密钥示例

您可以通过要求在 APIs 模板中使用 API 密钥来控制对 AWS SAM 的访问。为此,您可以使用 ApiAuth 数据类型。

以下是 API 密钥的示例 AWS SAM 模板部分:

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Auth:
        ApiKeyRequired: true # sets for all methods

  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: .
      Handler: index.handler
      Runtime: nodejs12.x
      Events:
        ApiKey:
          Type: Api
          Properties:
            RestApiId: !Ref MyApi
            Path: /
            Method: get
            Auth:
              ApiKeyRequired: true

有关 API 密钥的更多信息,请参阅 https://docs.amazonaws.cn/apigateway/latest/developerguide/api-gateway-api-usage-plans.html 中的创建和使用带 API 密钥的使用计划API 网关 开发人员指南。