HttpApiCorsConfiguration

Mengelola cross-origin resource sharing (CORS) untuk API HTTP Anda. Tentukan domain untuk diizinkan sebagai string atau tentukan kamus dengan konfigurasi Cors tambahan. CATATAN: Cor membutuhkan SAM untuk memodifikasi definisi OpenAPI Anda, sehingga hanya berfungsi dengan OpenApi sebaris yang ditentukan di properti. DefinitionBody

Untuk informasi lebih lanjut tentang CORS, lihat Mengonfigurasi CORS untuk API HTTP di Panduan Developer API Gateway.

Catatan: Jika HttpApiCorsConfiguration disetel baik di OpenAPI maupun di tingkat properti, AWS SAM gabungkan mereka dengan properti yang diutamakan.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  AllowCredentials: Boolean
  AllowHeaders: List
  AllowMethods: List
  AllowOrigins: List
  ExposeHeaders: List
  MaxAge: Integer

Properti

AllowCredentials

Menentukan apakah kredensial termasuk dalam permintaan CORS.

Tipe: Boolean

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

AllowHeaders

Merupakan kumpulan header yang diizinkan.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

AllowMethods

Merupakan kumpulan metode HTTP yang diizinkan.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

AllowOrigins

Merupakan kumpulan asal yang diizinkan.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

ExposeHeaders

Merupakan kumpulan header yang terekspos.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

MaxAge

Jumlah detik ketika peramban harus men-cache hasil permintaan penerbangan awal.

Tipe: Integer

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

HttpApiCorsConfiguration

Contoh Konfigurasi Cors API HTTP.

YAML

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