RouteConfiguration

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

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

Properties

ApiKeyRequired

Speciifica se è necessaria una chiave API per questo percorso.

Tipo: Booleano

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla ApiKeyRequired proprietà di una AWS::ApiGatewayV2::Route risorsa.

FunctionArn

L'ARN della funzione Lambda che gestisce questa rotta. AWS SAM crea un'integrazione e le autorizzazioni necessarie affinché API Gateway richiami la funzione.

▬Tipo: stringa

Obbligatorio: sì

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

IntegrationTimeout

Il timeout per l'integrazione, in millisecondi. Il valore massimo è 29.000 millisecondi (29 secondi).

Tipo: integer

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla TimeoutInMillis proprietà di una risorsa. AWS::ApiGatewayV2::Integration

ModelSelectionExpression

L'espressione di selezione del modello per l'instradamento.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla ModelSelectionExpression proprietà di una AWS::ApiGatewayV2::Route risorsa.

OperationName

Il nome dell'operazione per l'instradamento.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla OperationName proprietà di una AWS::ApiGatewayV2::Route risorsa.

RequestModels

I modelli di richiesta per l'instradamento.

Type: Json

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla RequestModels proprietà di una AWS::ApiGatewayV2::Route risorsa.

RequestParameters

I parametri della richiesta per l'instradamento.

Type: Json

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla RequestParameters proprietà di una AWS::ApiGatewayV2::Route risorsa.

RouteResponseSelectionExpression

L'espressione di selezione della risposta dell'instradamento per l'instradamento.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla RouteResponseSelectionExpression proprietà di una AWS::ApiGatewayV2::Route risorsa.

Esempi

Percorso semplice

L'esempio seguente configura un percorso semplice.

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