x-amazon-apigateway-endpoint-konfigurasi objek

Menentukan rincian konfigurasi endpoint untuk API. Ekstensi ini adalah properti yang diperluas dari objek Operasi OpenAPI. Objek ini harus ada di ekstensi vendor tingkat atas untuk Swagger 2.0. Untuk OpenAPI 3.0, itu harus ada di bawah ekstensi vendor dari objek Server.

Properti
Nama properti	Tipe	Deskripsi
disableExecuteApiEndpoint	Boolean	Menentukan apakah klien dapat memanggil API dengan menggunakan titik akhir execute-api default. Secara default, klien dapat memanggil API Anda dengan titik https://{api_id}.execute-api.{region}.amazonaws.com akhir default. Untuk mengharuskan klien menggunakan nama domain khusus untuk menjalankan API Anda, tentukantrue.
vpcEndpointIds	Sebuah array dari String	Daftar VpcEndpoint pengidentifikasi yang digunakan untuk membuat catatan alias Route 53 untuk REST API. Ini hanya didukung untuk REST API tipe PRIVATE titik akhir.

x-amazon-apigateway-endpoint-contoh konfigurasi

Contoh berikut mengaitkan titik akhir VPC tertentu ke REST API.

"x-amazon-apigateway-endpoint-configuration": {
    "vpcEndpointIds": ["vpce-0212a4ababd5b8c3e", "vpce-01d622316a7df47f9"]
}

Contoh berikut menonaktifkan titik akhir default untuk API.

"x-amazon-apigateway-endpoint-configuration": {
    "disableExecuteApiEndpoint": true
}