HttpApiCorsConfiguration - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

HttpApiCorsConfiguration

为您的 HTTP API 管理跨源资源共享 (CORS)。将允许的域指定为字符串,或者指定带有其他 Cos 配置的字典。注意:Cos 要求 SAM 修改你的 OpenAPI 定义,因此它只适用于DefinitionBody财产。

有关 CORS 的更多信息,请参阅。为 HTTP API 配置 CORS中的API Gateway 开发人员指南.

注意:如果在 OpenAPI 和属性级别都设置了 HTTPiCORS 配置,Amazon SAM将它们与优先属性合并。

Syntax

要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。

YAML

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

Properties

AllowCredentials

指定是否在 CORS 请求中包含凭证。

类型:Boolean

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

AllowHeaders

表示允许的标头集合。

类型:List

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

AllowMethods

表示允许的 HTTP 方法集合。

类型:List

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

AllowOrigins

表示允许的源集合。

类型:List

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

ExposeHeaders

表示公开的标头集合。

类型:List

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

MaxAge

浏览器应缓存预检请求结果的秒数。

类型:整数

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

Examples

HttpApiCorsConfiguration

HTTP API Cos 配置示例。

YAML

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