RouteConfiguration

Sintaxis

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

YAML

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

Propiedades

ApiKeyRequired

Especifica si se requiere una clave de API para esta ruta.

Tipo: Booleano

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la ApiKeyRequired propiedad de un AWS::ApiGatewayV2::Route recurso.

FunctionArn

El ARN de la función Lambda que gestiona esta ruta. AWS SAM crea una integración y los permisos necesarios para que API Gateway invoque la función.

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

IntegrationTimeout

El tiempo de espera de la integración, en milisegundos. El valor máximo es de 29 000 milisegundos (29 segundos).

Tipo: entero

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la TimeoutInMillis propiedad de un AWS::ApiGatewayV2::Integration recurso.

ModelSelectionExpression

Es la expresión de selección del modelo para la ruta.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la ModelSelectionExpression propiedad de un AWS::ApiGatewayV2::Route recurso.

OperationName

Es el nombre de la operación para la ruta.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la OperationName propiedad de un AWS::ApiGatewayV2::Route recurso.

RequestModels

Son los modelos de solicitud para la ruta.

Tipo: Json

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la RequestModels propiedad de un AWS::ApiGatewayV2::Route recurso.

RequestParameters

Son los parámetros de solicitud para la ruta.

Tipo: Json

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la RequestParameters propiedad de un AWS::ApiGatewayV2::Route recurso.

RouteResponseSelectionExpression

Es la expresión de selección de respuesta de la ruta para la ruta.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la RouteResponseSelectionExpression propiedad de un AWS::ApiGatewayV2::Route recurso.

Ejemplos

Ruta sencilla

El siguiente ejemplo configura una ruta sencilla.

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