HttpApiCorsConfiguration - AWS Serverless Application Model
语法属性示例

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

HttpApiCorsConfiguration

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

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

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

语法

要在您的 AWS Serverless Application Model (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