RouteConfiguration

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。

YAML

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

Properties

ApiKeyRequired

指定此路由是否需要 API 金鑰。

類型：布林值

必要：否

CloudFormation 相容性：此屬性會直接傳遞至 AWS::ApiGatewayV2::Route 資源的 ApiKeyRequired 屬性。

FunctionArn

處理此路由的 Lambda 函數 ARN。 會 AWS SAM 建立整合和 API Gateway 叫用函數的必要許可。

類型：字串

必要：是

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