HttpApiAuth - AWS Serverless Application Model
語法Properties範例

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

HttpApiAuth

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

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

語法

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

Properties

Authorizers

用於控制 API Gateway API 存取的授權方。

類型：OAuth2Authorizer | LambdaAuthorizer

必要：否

預設：無

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

其他備註：將授權方 AWS SAM 新增至 OpenAPI 定義。

DefaultAuthorizer

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

類型：字串

必要：否

預設：無

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

EnableIamAuthorizer

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

類型：布林值

必要：否

CloudFormation 相容性：此屬性對 是唯一的 AWS SAM ，並且沒有 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