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

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

HttpApiCorsConfiguration

管理 HTTP APIs 的跨源资源共享 (CORS)。 指定要允许使用作为字符串的域,或使用其他 Cors 配置指定词典。注意:Cors 要求 SAM 修改您的 OpenAPI 定义,因此它仅适用于在 OpenApi 属性中定义的内联 DefinitionBody

有关 CORS 的更多信息,请参阅 https://docs.amazonaws.cn/apigateway/latest/developerguide/http-api-cors.html 中的为 HTTP API 配置 CORSAPI 网关 开发人员指南。

注意:如果在 HttpApiCorsConfiguration 和属性级别都设置了 OpenAPI,则 AWS SAM 会将它们与优先属性合并。

语法

在您的 中声明此实体 AWS 无服务器应用程序模型 (AWS SAM) 模板时,请使用以下语法。

YAML

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

属性

AllowCredentials

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

类型:布尔值

必需: 否

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

AllowHeaders

表示允许的标头集合。

类型:列表

必需: 否

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

AllowMethods

表示允许的 HTTP 方法集合。

类型:列表

必需: 否

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

AllowOrigins

表示允许的源集合。

类型:列表

必需: 否

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

ExposeHeaders

表示公开的标头集合。

类型:列表

必需: 否

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

MaxAge

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

类型:整数

必需: 否

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

示例

HttpApiCorsConfiguration

HTTP API Cors 配置示例。

YAML

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