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

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

CorsConfiguration

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

有关 CORS 的更多信息,请参阅 https://docs.amazonaws.cn/apigateway/latest/developerguide/how-to-cors.html 中的为 API Gateway REST API 资源启用 CORSAPI 网关 开发人员指南。

注意:如果在 CorsConfiguration 和属性级别设置 OpenAPI,则 AWS SAM 合并它们,并且属性优先。

语法

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

YAML

AllowCredentials: Boolean AllowHeaders: String AllowMethods: String AllowOrigin: String MaxAge: String

属性

AllowCredentials

指示是否允许请求包含凭证的布尔值。

类型:布尔值

必需: 否

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

AllowHeaders

允许的标头的字符串。

类型:字符串

必需: 否

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

AllowMethods

包含允许的 HTTP 方法的字符串。

类型:字符串

必需: 否

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

AllowOrigin

允许的源字符串。

类型:字符串

必需: 是

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

MaxAge

包含缓存 CORS 预检请求的秒数的字符串。

类型:字符串

必需: 否

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

示例

CorsConfiguration

Cors 配置示例。这只是 AWS SAM 模板文件的一部分,显示了配置了 Cors 的 AWS::Serverless::Api 定义。

YAML

Resources: ApiGatewayApi: Type: AWS::Serverless::Api Properties: StageName: Prod Cors: AllowMethods: "'POST, GET'" AllowHeaders: "'X-Forwarded-For'" AllowOrigin: "'www.example.com'" MaxAge: "'600'" AllowCredentials: True