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

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

CorsConfiguration

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

有关 CORS 的更多信息,请参阅。为 API Gateway API 资源启用 CORS中的API Gateway 开发人员指南.

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

Syntax

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

YAML

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

Properties

AllowCredentials

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

类型:Boolean

必需:否

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

AllowHeaders

要允许的标题字符串。

类型:String

必需:否

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

AllowMethods

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

类型:String

必需:否

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

AllowOrigin

要允许的原始字符串。

类型:String

必需:是

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

MaxAge

包含缓存 CORS 印前检查请求的秒数的字符串。

类型:String

必需:否

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

Examples

CorsConfiguration

Cos 配置示例。这只是一个版本的一部分Amazon SAM显示模板文件AWS::Serverless::Api配置了 Cro 的定义。

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