HttpApiCorsConfiguration - AWS Serverless Application Model
語法屬性範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

HttpApiCorsConfiguration

管理 HTTP API 的跨來源資源共用 (CORS)。指定允許作為字符串的域或指定帶有其他 CRS 配置的字典。注意：科爾斯要求 SAM 修改您的 OpenAPI 定義，因此它僅適用於在屬性中 OpenApi 定義的內聯定義。DefinitionBody

如需有關 CORS 的詳細資訊，請參閱 API Gateway 開發人員指南中的針對 HTTP API 設定 CO RS。

注意：如果 HttpApiCorsConfiguration 同時在 OpenAPI 和屬性層級設定，則會將它們與 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 協議配置示例。

YAML

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