RequestParameter - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

RequestParameter

Configura un parámetro de solicitud para una API+ruta+método específicos.

Se debe especificar una propiedad tanto Required como Caching para el parámetro de solicitud

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

  Caching: Boolean
  Required: Boolean

Propiedades

Caching

Añade la sección cacheKeyParameters a la definición de la puerta de enlace API OpenApi

Tipo: Booleano

Obligatorio: Condicional

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

Required

Este campo especifica si un parámetro es necesario.

Tipo: Booleano

Obligatorio: condicional

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

Ejemplos

Parámetro de solicitud

Ejemplo de configuración de los parámetros de solicitud

YAML

RequestParameters:
  - method.request.header.Authorization:
      Required: true
      Caching: true