HttpApiCorsConfiguration

Administra el intercambio de recursos de origen cruzado (CORS) para las API HTTP. Especifique el dominio que desea permitir como cadena o especifique 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 los elementos OpenApi en línea definidos en la propiedad. DefinitionBody

Para obtener más información acerca de las API de HTTP, consulte 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, las AWS SAM fusiona con las propiedades que tienen prioridad.

Sintaxis

Para declarar esta entidad en tu plantilla 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

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

AllowHeaders

Representa una colección de encabezados permitidos.

Tipo: lista

Obligatorio: no

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

AllowMethods

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

Tipo: lista

Obligatorio: no

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

AllowOrigins

Representa una colección de orígenes permitidos.

Tipo: lista

Obligatorio: no

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

ExposeHeaders

Representa una colección de encabezados expuestos.

Tipo: lista

Obligatorio: no

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

MaxAge

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

Tipo: entero

Obligatorio: no

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

Ejemplos

HttpApiCorsConfiguration

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