RouteConfiguration

Sintaxe

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

YAML

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

Propriedades

ApiKeyRequired

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 propriedade de um AWS::ApiGatewayV2::Route recurso.

FunctionArn

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

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 propriedade de um AWS::ApiGatewayV2::Integration recurso.

ModelSelectionExpression

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 propriedade de um AWS::ApiGatewayV2::Route recurso.

OperationName

O nome da operação para a rota.

Tipo: string

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a OperationName propriedade de um AWS::ApiGatewayV2::Route recurso.

RequestModels

Os modelos de solicitação para a rota.

Tipo: Json

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a RequestModels propriedade de um AWS::ApiGatewayV2::Route recurso.

RequestParameters

Os parâmetros de solicitação para a rota.

Tipo: Json

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a RequestParameters propriedade de um AWS::ApiGatewayV2::Route recurso.

RouteResponseSelectionExpression

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 propriedade de um AWS::ApiGatewayV2::Route recurso.

Exemplos

Rota simples

O exemplo a seguir configura uma rota simples.

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