HttpApi

タイプ のイベントソースを記述するオブジェクト HttpApi。

指定されたパスとメソッド OpenApi の定義が API に存在する場合、SAM は Lambda 統合とセキュリティセクション (該当する場合) を追加します。

API に指定されたパスとメソッド OpenApi の定義が存在しない場合、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 リソースの識別子です。

定義されていない場合、 を指定しないこのテンプレートで定義された Api イベントで定義されたすべてのパスとメソッドの和集合を含む生成された 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 リソースソースとイベントソースの両方で が指定され AWS SAM ている場合、 RouteSettings はイベントソースプロパティが優先されます。

タイプ： 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