HttpApiAuth - Amazon Serverless Application Model
语法属性示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

HttpApiAuth

配置授权来控制对 Amazon API Gateway HTTP API 的访问。

有关配置 HTTP API 访问权限的更多信息，请参阅控制和管理对 API Gateway 中 HTTP API 的访问中的API Gateway 开发人员指南.

语法

要在您的Amazon Serverless Application Model(Amazon SAM) 模板，请使用以下语法。

属性

Authorizers

用于控制对 API Gateway API 访问权限的授权方。

类型：OAth2授权者/授权器|LambdaAuthorizer

必需：否

默认值：无

Amazon CloudFormation兼容性：该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

附加说明：Amazon SAM将授权者添加到 OpenAPI 定义中。

DefaultAuthorizer

指定用于授权 API 调用 API Gateway 的默认授权方。您可以指定AWS_IAM作为默认授权者EnableIamAuthorizer设置为true. 否则，请指定您在中定义的授权者Authorizers.

类型：字符串

必需：否

默认值：无

Amazon CloudFormation兼容性：该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

EnableIamAuthorizer

指定是否对 API 路由使用 IAM 授权。

类型：布尔值

必需：否

Amazon CloudFormation兼容性：该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

示例

OAuth 2.0 授权方

OAuth 2.0 授权方示例

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

IAM 授权方

IAM 授权方示例

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM