x-amazon-apigateway-endpoint-konfigurasi objek - APIGerbang Amazon
x-amazon-apigateway-endpoint-contoh konfigurasi

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

x-amazon-apigateway-endpoint-konfigurasi objek

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

Nama properti Tipe Deskripsi
disableExecuteApiEndpoint Boolean

Menentukan apakah klien dapat memanggil Anda API dengan menggunakan endpoint defaultexecute-api. Secara default, klien dapat memanggil Anda API dengan titik https://{api_id}.execute-api.{region}.amazonaws.com akhir default. Untuk mengharuskan klien menggunakan nama domain khusus untuk memanggil AndaAPI, tentukantrue.
vpcEndpointIds Sebuah array String

Daftar VpcEndpoint pengidentifikasi yang digunakan untuk membuat catatan alias Route 53 untuk file. REST API Ini hanya didukung untuk REST APIs tipe PRIVATE titik akhir.

x-amazon-apigateway-endpoint-contoh konfigurasi

Contoh berikut mengaitkan VPC titik akhir tertentu ke. REST API

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

Contoh berikut menonaktifkan endpoint default untuk sebuah. API

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