Api

Api イベントソースタイプを説明するオブジェクトです。AWS::Serverless::Api リソースが定義されている場合、パスとメソッドの値は、API の OpenApi 定義にあるオペレーションに対応している必要があります。

構文

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

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String
  UnescapeMappingTemplate: Boolean

プロパティ

Auth

この API、パス、およびメソッドの認証設定です。

このプロパティを使用して、DefaultAuthorizer が指定されていない場合、またはデフォルトの ApiKeyRequired 設定を上書きするために、個々のパスに対する API の DefaultAuthorizer 設定を上書きします。

タイプ： ApiStateMachineAuth

必須: いいえ

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

Method

この関数が呼び出される HTTP メソッドです。

タイプ: 文字列

必須: はい

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

Path

この関数が呼び出される URI パスです。値は / で始める必要があります。

タイプ: 文字列

必須: はい

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

RestApiId

RestApi リソースの識別子で、所定のパスとメソッドでのオペレーションが含まれている必要があります。これは通常、このテンプレートで定義された AWS::Serverless::Api リソースを参照するように設定されます。

このプロパティを定義しない場合、 AWS SAM は生成されたOpenApiドキュメントを使用してデフォルトのAWS::Serverless::Apiリソースを作成します。そのリソースには、RestApiId を指定しない同じテンプレート内の Api イベントによって定義されるすべてのパスとメソッドの和集合が含まれます。

このプロパティは、別のテンプレートで定義された AWS::Serverless::Api リソースを参照できません。

タイプ: 文字列

必須: いいえ

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

UnescapeMappingTemplate

\' を ' に置き換えて、ステートマシンに渡される入力の一重引用符のエスケープを解除します。入力に一重引用符が含まれている場合に使用します。

注記

False に設定し、入力に一重引用符が含まれている場合、エラーが発生します。

タイプ: ブール

必須: いいえ

デフォルト: False

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

例

ApiEvent

以下は、Api タイプのイベントの例です。

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get