

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

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

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

### 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}}
```

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

 `ApiKeyRequired`   <a name="sam-routeconfiguration-apikeyrequired"></a>
Especifica se uma chave de API é necessária para essa rota.  
*Tipo*: booliano  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[ApiKeyRequired](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired)` propriedade de um `AWS::ApiGatewayV2::Route` recurso.

 `FunctionArn`   <a name="sam-routeconfiguration-functionarn"></a>
O ARN da função Lambda que gerencia essa rota. AWS SAM cria uma integração e as permissões necessárias para que o API Gateway invoque a função.  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `IntegrationTimeout`   <a name="sam-routeconfiguration-integrationtimeout"></a>
O tempo limite para a integração, em milissegundos. O valor máximo é 29.000 milissegundos (29 segundos).  
*Tipo*: inteiro  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[TimeoutInMillis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis)` propriedade de um `AWS::ApiGatewayV2::Integration` recurso.

 `ModelSelectionExpression`   <a name="sam-routeconfiguration-modelselectionexpression"></a>
A expressão de seleção de modelo para a rota.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[ModelSelectionExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression)` propriedade de um `AWS::ApiGatewayV2::Route` recurso.

 `OperationName`   <a name="sam-routeconfiguration-operationname"></a>
O nome da operação para a rota.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[OperationName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname)` propriedade de um `AWS::ApiGatewayV2::Route` recurso.

 `RequestModels`   <a name="sam-routeconfiguration-requestmodels"></a>
Os modelos de solicitação para a rota.  
*Tipo*: Json  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[RequestModels](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels)` propriedade de um `AWS::ApiGatewayV2::Route` recurso.

 `RequestParameters`   <a name="sam-routeconfiguration-requestparameters"></a>
Os parâmetros de solicitação para a rota.  
*Tipo*: Json  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[RequestParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters)` propriedade de um `AWS::ApiGatewayV2::Route` recurso.

 `RouteResponseSelectionExpression`   <a name="sam-routeconfiguration-routeresponseselectionexpression"></a>
A expressão de seleção de resposta de rota para a rota.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[RouteResponseSelectionExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression)` propriedade de um `AWS::ApiGatewayV2::Route` recurso.

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

### Rota simples
<a name="sam-property-websocketapi-routeconfiguration-examples-simple"></a>

O exemplo a seguir configura uma rota simples.

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