HttpApiAuth - AWS Serverless Application Model

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

HttpApiAuth

Amazon API Gateway HTTP API へのアクセスを制御するための認証を設定します。

HTTP API へのアクセスを設定する方法の詳細については、」API Gateway での HTTP API へのアクセスの制御と管理()API Gateway 開発者ガイド

Syntax

このエンティティを宣言するには、AWS Serverless Application Model AWS SAM テンプレートでは、次の構文を使用します。

Properties

Authorizers

API Gateway API へのアクセスを制御するために使用されるオーソライザー。

タイプ: OAuth2Authorizer|ラムダオーソライザ

必須: いいえ

デフォルト値: なし

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

追加のメモ: AWS SAM は OpenAPI 定義にオーソリザを追加します。

DefaultAuthorizer

API Gateway API への API 呼び出しの認証に使用するデフォルトの認証を指定します。

タイプ: 文字列

必須: いいえ

デフォルト値: なし

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

Examples

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