View a markdown version of this page

RouteConfiguration - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

RouteConfiguration

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

Eigenschaften

ApiKeyRequired

Gibt an, ob ein API-Schlüssel für diese Route erforderlich ist.

Typ: Boolesch

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die ApiKeyRequired Eigenschaft einer AWS::ApiGatewayV2::Route Ressource übergeben.

FunctionArn

Der ARN der Lambda-Funktion, die diese Route verarbeitet. AWS SAM erstellt eine Integration und die erforderlichen Berechtigungen für API Gateway, um die Funktion aufzurufen.

Typ: Zeichenfolge

Erforderlich: Ja

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

IntegrationTimeout

Das Timeout für die Integration in Millisekunden. Der Höchstwert beträgt 29.000 Millisekunden (29 Sekunden).

Typ: Ganzzahl

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die TimeoutInMillis Eigenschaft einer Ressource übergeben. AWS::ApiGatewayV2::Integration

ModelSelectionExpression

Der Modell-Auswahlausdruck für die Route.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die ModelSelectionExpression Eigenschaft einer AWS::ApiGatewayV2::Route Ressource übergeben.

OperationName

Der Operationsname für die Route.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die OperationName Eigenschaft einer AWS::ApiGatewayV2::Route Ressource übergeben.

RequestModels

Die Anforderungsmodelle für die Route.

Type: Json

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die RequestModels Eigenschaft einer AWS::ApiGatewayV2::Route Ressource übergeben.

RequestParameters

Die Anforderungsparameter für die Route.

Type: Json

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die RequestParameters Eigenschaft einer AWS::ApiGatewayV2::Route Ressource übergeben.

RouteResponseSelectionExpression

Der Routing-Antwort-Auswahlausdruck für die Route.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die RouteResponseSelectionExpression Eigenschaft einer AWS::ApiGatewayV2::Route Ressource übergeben.

Beispiele

Einfache Route

Das folgende Beispiel konfiguriert eine einfache Route.

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