HttpApi

タイプ のイベントソースを説明するオブジェクト 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 ドキュメントServerlessHttpApiを使用して、デフォルトの AWS::Serverless::HttpApiリソースが作成されます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

統合に送信されるペイロードの形式を指定します。

注: OpenAPI 定義を変更するには SAM PayloadFormatVersion が必要なため、 DefinitionBodyプロパティで OpenApi 定義されたインラインでのみ機能します。

タイプ: 文字列

必須: いいえ

デフォルト: 2.0

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

RouteSettings

この HTTP API に対するルートごとのルート設定です。ルート設定の詳細については、API Gateway デベロッパーガイドAWS::ApiGatewayV2::Stage RouteSettingsの「」を参照してください。

注: が HttpApi リソースソースとイベントソースの両方で指定されている場合、 RouteSettings はそれらをAWS SAMマージし、イベントソースプロパティが優先されます。

と入力します。 RouteSettings

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::ApiGatewayV2::Stage リソースの RouteSettings プロパティに直接渡されます。

TimeoutInMillis

50～29,000 ミリ秒のカスタムタイムアウトです。

注: OpenAPI 定義を変更するには SAM TimeoutInMillis が必要なため、 DefinitionBodyプロパティで 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

HttpApi 認可

HttpApi オーソライザーを使用するイベント。

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2