翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
HttpApi タイプのイベントソースを説明するオブジェクトです。
指定したパスとメソッドの OpenApi 定義が API に存在する場合、SAM は Lambda 統合とセキュリティセクション (該当する場合) を追加します。
指定したパスとメソッドの OpenApi 定義が API に存在しない場合は、SAM がこの定義を作成します。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
ApiId: String
Auth: HttpApiFunctionAuth
Method: String
Path: String
PayloadFormatVersion: String
RouteSettings: RouteSettings
TimeoutInMillis: Integer
プロパティ
-
ApiId
-
このテンプレートで定義されている AWS::Serverless::HttpApi リソースの識別子です。
定義されていない場合、生成された OpenApi ドキュメント (AWS::Serverless::HttpApi を指定しないこのテンプレートで定義された Api イベントによって定義されるすべてのパスとメソッドの和集合が含まれるもの) を使用して、
ServerlessHttpApi
と呼ばれるデフォルトのApiId
リソースが作成されます。これは、別のテンプレートで定義された AWS::Serverless::HttpApi リソースを参照できません。
型: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
Auth
-
この特定の Api とパスとメソッドの認証設定です。
API の
DefaultAuthorizer
を上書きする、またはDefaultAuthorizer
が指定されていない場合に個々のパス上の認証設定を設定するために役立ちます。タイプ: HttpApiFunctionAuth
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
Method
-
この関数が呼び出される HTTP メソッドです。
Path
とMethod
が指定されていない場合は、SAM がデフォルトの API パスを作成します。このパスは、別のエンドポイントにマップされないリクエストをこの Lambda 関数にルーティングします。これらのデフォルトパスは、API ごとに 1 つしか存在できません。型: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
Path
-
この関数が呼び出される URI パスです。
/
で始まる必要があります。Path
とMethod
が指定されていない場合は、SAM がデフォルトの API パスを作成します。このパスは、別のエンドポイントにマップされないリクエストをこの Lambda 関数にルーティングします。これらのデフォルトパスは、API ごとに 1 つしか存在できません。型: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
PayloadFormatVersion
-
統合に送信されるペイロードの形式を指定します。
注意: PayloadFormatVersion では OpenAPI 定義の変更に SAM が必要となるため、これが機能するのは
DefinitionBody
で Inline OpenApi が定義されている場合のみです。型: 文字列
必須: いいえ
デフォルト: 2.0
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
RouteSettings
-
この HTTP API に対するルートごとのルート設定です。ルート設定の詳細については、API Gateway デベロッパーガイドの「AWS::ApiGatewayV2::Stage RouteSettings」を参照してください。
注意: HttpApi リソースとイベントソースの両方で RouteSettings が 指定されている場合、AWS SAM はそれらを統合し、イベントソースが優先されます。
Type: RouteSettings
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::ApiGatewayV2::Stage
リソースのRouteSettings
プロパティに直接渡されます。 -
TimeoutInMillis
-
50~29,000 ミリ秒のカスタムタイムアウトです。
注意: TimeoutInMillis では OpenAPI 定義の変更に SAM が必要となるため、これが機能するのは
DefinitionBody
で Inline OpenApi が定義されている場合のみです。タイプ: 整数
必須: いいえ
デフォルト: 5000
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
例
デフォルトの HttpApi イベント
デフォルトパスを使用する HttpApi イベントです。この API 上にあるマップされていないパスとメソッドのすべてがこのエンドポイントにルーティングされます。
YAML
Events:
HttpApiEvent:
Type: HttpApi
HttpApi
特定のパスとメソッドを使用する HttpApi イベントです。
YAML
Events:
HttpApiEvent:
Type: HttpApi
Properties:
Path: /
Method: GET
HTTP API の認可
オーソライザーを使用する HttpApi イベントです。
YAML
Events:
HttpApiEvent:
Type: HttpApi
Properties:
Path: /authenticated
Method: GET
Auth:
Authorizer: OpenIdAuth
AuthorizationScopes:
- scope1
- scope2