HttpApiCorsConfiguration - AWS Serverless Application Model

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

Administre el uso compartido de recursos entre orígenes (CORS) para sus API HTTP. Especifique el dominio que desea permitir como cadena o especifique un diccionario con configuración adicional de Cors. NOTA: Cors requiere que SAM modifique su definición de OpenAPI, por lo que solo funciona con OpenAPI en línea definida en elDefinitionBodypropiedad.

Para obtener más información acerca de CORS, consulteConfiguración de CORS para una API HTTPen laGuía para desarrolladores de API Gateway.

Nota: Si HttpPicorsConfiguration se establece tanto en OpenAPI como en el nivel de propiedad,AWS SAMlos fusiona con las propiedades que tienen prioridad.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

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

Properties

AllowCredentials

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

Type: Booleano

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

AllowHeaders

Representa una colección de encabezados permitidos.

Type: Lista

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

AllowMethods

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

Type: Lista

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

AllowOrigins

Representa una colección de orígenes permitidos.

Type: Lista

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

ExposeHeaders

Representa una colección de encabezados expuestos.

Type: Lista

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

MaxAge

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

Type: Entero

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Ejemplos

Configuración de Httapicors

Ejemplo de configuración de HTTP API Cors.

YAML

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