本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# CorsConfiguration
管理 API Gateway APIs 的跨來源資源共用 (CORS)。指定要允許做為字串的網域，或指定具有其他 Cors 組態的字典。
**注意**
CORS 需要 AWS SAM 修改您的 OpenAPI 定義。在 中建立內嵌 OpenAPI 定義`DefinitionBody`以開啟 CORS。如果在 OpenAPI 定義和屬性層級設定 `CorsConfiguration` ， 會 AWS SAM 合併它們。屬性層級優先於 OpenAPI 定義。
如需 CORS 的詳細資訊，請參閱《 [API Gateway 開發人員指南》中的為 API Gateway REST API 資源啟用 CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html)。 **
## 語法
若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。
### YAML
```
[AllowCredentials](#sam-api-corsconfiguration-allowcredentials): Boolean
[AllowHeaders](#sam-api-corsconfiguration-allowheaders): String
[AllowMethods](#sam-api-corsconfiguration-allowmethods): String
[AllowOrigin](#sam-api-corsconfiguration-alloworigin): String
[MaxAge](#sam-api-corsconfiguration-maxage): String
```
## Properties
`AllowCredentials`
布林值，指出是否允許請求包含登入資料。
*類型*：布林值
*必要*：否
*CloudFormation 相容性*：此屬性對 是唯一的 AWS SAM ，並且沒有 CloudFormation 同等的。
`AllowHeaders`
要允許的標頭字串。
*類型：*字串
*必要*：否
*CloudFormation 相容性*：此屬性對 是唯一的 AWS SAM ，並且沒有 CloudFormation 同等屬性。
`AllowMethods`
包含要允許之 HTTP 方法的字串。
*類型：*字串
*必要*：否
*CloudFormation 相容性*：此屬性對 是唯一的 AWS SAM ，並且沒有 CloudFormation 同等的。
`AllowOrigin`
要允許的原始伺服器字串。這可以是字串格式的逗號分隔清單。
*類型：*字串
*必要*：是
*CloudFormation 相容性*：此屬性對 是唯一的 AWS SAM ，並且沒有 CloudFormation 同等屬性。
`MaxAge`
包含快取 CORS 預檢請求秒數的字串。
*類型：*字串
*必要*：否
*CloudFormation 相容性*：此屬性對 是唯一的 AWS SAM ，並且沒有 CloudFormation 同等的。
## 範例
### CorsConfiguration
CORS 組態範例。這只是 AWS SAM 範本檔案的一部分，顯示已設定 CORS 和 [AWS::Serverless::Api](sam-resource-api.md)的定義[AWS::Serverless::Function](sam-resource-function.md)。如果您使用 Lambda 代理整合或 HTTP 代理整合，您的後端必須傳回 `Access-Control-Allow-Origin`、 `Access-Control-Allow-Methods`和 `Access-Control-Allow-Headers`標頭。
#### YAML
```
Resources:
ApiGatewayApi:
Type: AWS::Serverless::Api
Properties:
StageName: Prod
Cors:
AllowMethods: "'POST, GET'"
AllowHeaders: "'X-Forwarded-For'"
AllowOrigin: "'https://example.com'"
MaxAge: "'600'"
AllowCredentials: true
ApiFunction: # Adds a GET method at the root resource via an Api event
Type: AWS::Serverless::Function
Properties:
Events:
ApiEvent:
Type: Api
Properties:
Path: /
Method: get
RestApiId:
Ref: ApiGatewayApi
Runtime: python3.10
Handler: index.handler
InlineCode: |
import json
def handler(event, context):
return {
'statusCode': 200,
'headers': {
'Access-Control-Allow-Headers': 'Content-Type',
'Access-Control-Allow-Origin': 'https://example.com',
'Access-Control-Allow-Methods': 'POST, GET'
},
'body': json.dumps('Hello from Lambda!')
}
```