HttpApiAuth

設定授權以控制對 Amazon API Gateway HTTP API 的存取。

如需設定 HTTP API 存取權的詳細資訊，請參閱《API Gateway 開發人員指南》中的「在 API Gateway 中控制和管理 HTTP API 的存取」。

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。

YAML

  Authorizers: OAuth2Authorizer | LambdaAuthorizer
  DefaultAuthorizer: String
  EnableIamAuthorizer: Boolean

屬性

Authorizers

用來控制 API Gateway API 存取權的授權者。

類型：授權者 | LambdaAuthorizer

必要：否

預設：無

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

其他注意事項： AWS SAM 將授權者新增至 OpenAPI 定義中。

DefaultAuthorizer

指定用於授權 API Gateway API 呼叫的預設授權者。如EnableIamAuthorizer果設定AWS_IAM為，您可以指定為預設授權者。true否則，請指定您在Authorizers中定義的授權者。

類型：字串

必要：否

預設：無

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

EnableIamAuthorizer

指定是否對 API 路由使用 IAM 授權。

類型：布林值

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

範例

驗證 2.0 授權者

驗證 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