RouteConfiguration

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

ApiKeyRequired

Spécifie si une clé d'API est requise pour cette route.

Type : valeur booléenne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la ApiKeyRequired propriété d'une AWS::ApiGatewayV2::Route ressource.

FunctionArn

L'ARN de la fonction Lambda qui gère cette route. AWS SAM crée une intégration et les autorisations nécessaires pour qu'API Gateway invoque la fonction.

Type : chaîne

Obligatoire : oui

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

IntegrationTimeout

Le délai d'expiration de l'intégration, en millisecondes. La valeur maximale est de 29 000 millisecondes (29 secondes).

Type : entier

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la TimeoutInMillis propriété d'une AWS::ApiGatewayV2::Integration ressource.

ModelSelectionExpression

Expression de sélection du modèle pour le routage.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la ModelSelectionExpression propriété d'une AWS::ApiGatewayV2::Route ressource.

OperationName

Nom de l'opération pour le routage.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la OperationName propriété d'une AWS::ApiGatewayV2::Route ressource.

RequestModels

Modèles de demande pour le routage.

Type : Json

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la RequestModels propriété d'une AWS::ApiGatewayV2::Route ressource.

RequestParameters

Paramètres de demande pour le routage.

Type : Json

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la RequestParameters propriété d'une AWS::ApiGatewayV2::Route ressource.

RouteResponseSelectionExpression

Expression de sélection de réponse du routage pour le routage.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la RouteResponseSelectionExpression propriété d'une AWS::ApiGatewayV2::Route ressource.

Exemples

Itinéraire simple

L'exemple suivant configure un itinéraire simple.

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