HttpApiCorsConfiguration - 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.

HttpApiCorsConfiguration

Administra el intercambio de recursos de origen cruzado (CORS) para las API HTTP. Especifica el dominio que quieres permitir como cadena o especifica un diccionario con una configuración de Cors adicional. NOTA: Cors requiere que SAM modifique la definición de OpenAPI, por lo que solo funciona con OpenAPI integrada definida en la propiedad DefinitionBody.

Para obtener más información acerca de las API de HTTP, consulta API de HTTP en la Guía para desarrolladores de API Gateway.

Nota: Si HttpApicorsConfiguration se establece tanto en OpenAPI como en el nivel de propiedad, AWS SAM las combina con las propiedades que tienen prioridad.

Sintaxis

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

YAML

  AllowCredentials: Boolean
  AllowHeaders: List
  AllowMethods: List
  AllowOrigins: List
  ExposeHeaders: List
  MaxAge: Integer

Propiedades

AllowCredentials

Especifica si las credenciales están incluidas en la solicitud de CORS.

Tipo: Booleano

Obligatorio: no

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

AllowHeaders

Representa una colección de encabezados permitidos.

Tipo: lista

Obligatorio: no

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

AllowMethods

Representa una colección de métodos HTTP permitidos.

Tipo: lista

Obligatorio: no

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

AllowOrigins

Representa una colección de orígenes permitidos.

Tipo: lista

Obligatorio: no

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

ExposeHeaders

Representa una colección de encabezados expuestos.

Tipo: lista

Obligatorio: no

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

MaxAge

Número de segundos durante los que el navegador debe almacenar en caché los resultados de la solicitud preliminar.

Tipo: entero

Obligatorio: no

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

Ejemplos

Configuración HTTP: Picors

Ejemplo de configuración básica de la API HTTP.

YAML

CorsConfiguration:
  AllowOrigins:
    - "https://example.com"
  AllowHeaders:
    - x-apigateway-header
  AllowMethods:
    - GET
  MaxAge: 600
  AllowCredentials: true