RouteConfiguration

構文

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

YAML

ApiKeyRequired: Boolean
FunctionArn: String
IntegrationTimeout: Integer
ModelSelectionExpression: String
OperationName: String
RequestModels: Json
RequestParameters: Json
RouteResponseSelectionExpression: String

プロパティ

ApiKeyRequired

このルートに API キーが必要かどうかを指定します。

型: ブール

必須: いいえ

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

FunctionArn

このルートを処理する Lambda 関数の ARN。 は、統合と、API Gateway が関数を呼び出すために必要なアクセス許可 AWS SAM を作成します。

タイプ: 文字列

必須: はい

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

IntegrationTimeout

統合のタイムアウトをミリ秒単位で表します。最大値は 29,000 ミリ秒 (29 秒) です。

タイプ: 整数

必須: いいえ

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

ModelSelectionExpression

ルートのモデル選択式です。

タイプ: 文字列

必須: いいえ

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

OperationName

ルートのオペレーション名です。

タイプ: 文字列

必須: いいえ

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

RequestModels

ルートのリクエストモデルです。

型: Json

必須: いいえ

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

RequestParameters

ルートのリクエストパラメータです。

型: Json

必須: いいえ

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

RouteResponseSelectionExpression

ルートのルートレスポンス選択式です。

タイプ: 文字列

必須: いいえ

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

例

シンプルなルート

次の の例では、シンプルなルートを設定します。

Routes:
  $connect:
    FunctionArn: !GetAtt ConnectFunction.Arn
  sendMessage:
    FunctionArn: !GetAtt SendMessageFunction.Arn
    OperationName: SendMessage