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 へのアクセスを制御するために使用されるオーソライザーです。

タイプ： OAuth2Authorizer | LambdaAuthorizer

必須: いいえ

デフォルト: なし

AWS CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

その他の注意事項： OpenAPI 定義にオーソライザー AWS SAM を追加します。

DefaultAuthorizer

API Gateway API に対する API コールの認証に使用するデフォルトのオーソライザーを指定します。EnableIamAuthorizer が true に設定されている場合、AWS_IAM をデフォルトの承認者として指定できます。それ以外の場合は、Authorizers で定義した承認者を指定します。

タイプ: 文字列

必須: いいえ

デフォルト: なし

AWS CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

EnableIamAuthorizer

API ルートに IAM 認証を使用するかどうかを指定します。

タイプ: ブール

必須: いいえ

AWS CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 AWS 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