

# x-amazon-apigateway-cors オブジェクト
<a name="api-gateway-swagger-extensions-cors-configuration"></a>

HTTP API のクロスオリジンリソース共有 (CORS) 設定を指定します。この拡張機能は、ルートレベルの OpenAPI 構造に適用されます。詳細については、「[API Gateway で HTTP API の CORS を設定する](http-api-cors.md)」を参照してください。


| プロパティ名 | タイプ | 説明 | 
| --- | --- | --- | 
| allowOrigins | Array |  許可されたオリジンを指定します。  | 
| allowCredentials | Boolean |  CORS リクエストに認証情報を含めるかどうかを指定します。  | 
| exposeHeaders | Array |  公開されるヘッダーを指定します。  | 
| maxAge | Integer |  ブラウザがプリフライトリクエスト結果をキャッシュする秒数を指定します。  | 
| allowMethods | Array |  許可される HTTP メソッドを指定します。  | 
| allowHeaders | Array |  許可されるヘッダーを指定します。  | 

## x-amazon-apigateway-cors の例
<a name="api-gateway-swagger-extensions-cors-configuration"></a>

HTTP API の CORS 設定の例を次に示します。

```
"x-amazon-apigateway-cors": {
    "allowOrigins": [
      "https://www.example.com"
    ],
    "allowCredentials": true,
    "exposeHeaders": [
      "x-apigateway-header",
      "x-amz-date",
      "content-type"
    ],
    "maxAge": 3600,
    "allowMethods": [
      "GET",
      "OPTIONS",
      "POST"
    ],
    "allowHeaders": [
      "x-apigateway-header",
      "x-amz-date",
      "content-type"
    ]
}
```