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

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

CorsConfiguration

管理API网关API的跨源资源共享(CORS)。指定允许作为串的域,或指定包含其他Cors配置的字典。注意:Cors需要SAM修改您的OpenAPI定义,因此它仅适用于在 DefinitionBody 属性。

有关CORS的更多信息,请参阅 为API网关RESTAPI资源启用CORS 的。

注意 如果已在OpenAPI和属性级别设置Cors配置, 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

包含允许的HTTPS方法的串。

类型:字符串

必需: 否

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的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