本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# RouteConfiguration
<a name="sam-property-websocketapi-routeconfiguration"></a>

## 语法
<a name="sam-property-websocketapi-routeconfiguration-syntax"></a>

要在 Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体，请使用以下语法。

### YAML
<a name="sam-property-websocketapi-routeconfiguration-syntax.yaml"></a>

```
[ApiKeyRequired](#sam-routeconfiguration-apikeyrequired): {{Boolean}}
[FunctionArn](#sam-routeconfiguration-functionarn): {{String}}
[IntegrationTimeout](#sam-routeconfiguration-integrationtimeout): {{Integer}}
[ModelSelectionExpression](#sam-routeconfiguration-modelselectionexpression): {{String}}
[OperationName](#sam-routeconfiguration-operationname): {{String}}
[RequestModels](#sam-routeconfiguration-requestmodels): {{Json}}
[RequestParameters](#sam-routeconfiguration-requestparameters): {{Json}}
[RouteResponseSelectionExpression](#sam-routeconfiguration-routeresponseselectionexpression): {{String}}
```

## Properties
<a name="sam-property-websocketapi-routeconfiguration-properties"></a>

 `ApiKeyRequired`   <a name="sam-routeconfiguration-apikeyrequired"></a>
指定此路线是否需要 API 密钥。  
*类型*：布尔值  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Route`资源的`[ApiKeyRequired](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired)`属性。

 `FunctionArn`   <a name="sam-routeconfiguration-functionarn"></a>
处理此路由的 Lambda 函数的 ARN。 Amazon SAM 创建集成和 API Gateway 调用该函数所需的权限。  
*类型*：字符串  
*是否必需*：是  
*Amazon CloudFormation 兼容性*：此属性是独有的 Amazon SAM ，没有 Amazon CloudFormation 等效属性。

 `IntegrationTimeout`   <a name="sam-routeconfiguration-integrationtimeout"></a>
集成的超时时间，以毫秒为单位。最大值为 29,000 毫秒（29 秒）。  
*类型*：整数  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Integration`资源的`[TimeoutInMillis](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis)`属性。

 `ModelSelectionExpression`   <a name="sam-routeconfiguration-modelselectionexpression"></a>
路由的模型选择表达式。  
*类型*：字符串  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Route`资源的`[ModelSelectionExpression](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression)`属性。

 `OperationName`   <a name="sam-routeconfiguration-operationname"></a>
路由的操作名称。  
*类型*：字符串  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Route`资源的`[OperationName](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname)`属性。

 `RequestModels`   <a name="sam-routeconfiguration-requestmodels"></a>
路由的请求模型。  
*类型*：Json  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Route`资源的`[RequestModels](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels)`属性。

 `RequestParameters`   <a name="sam-routeconfiguration-requestparameters"></a>
路由的请求参数。  
*类型*：Json  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Route`资源的`[RequestParameters](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters)`属性。

 `RouteResponseSelectionExpression`   <a name="sam-routeconfiguration-routeresponseselectionexpression"></a>
路由的路由响应选择表达式。  
*类型*：字符串  
*必需*：否  
*Amazon CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Route`资源的`[RouteResponseSelectionExpression](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression)`属性。

## 示例
<a name="sam-property-websocketapi-routeconfiguration-examples"></a>

### 简单路线
<a name="sam-property-websocketapi-routeconfiguration-examples-simple"></a>

以下示例配置了一条简单路由。

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