View a markdown version of this page

objek konfigurasi x-amazon-apigateway-endpoint- - Amazon API Gateway
contoh konfigurasi x-amazon-apigateway-endpoint-

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

objek konfigurasi x-amazon-apigateway-endpoint-

Menentukan detail konfigurasi titik akhir untuk API. Ekstensi ini adalah properti yang diperluas dari objek Oper asi 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 objek https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#server-object Server.

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 https://{api_id}.execute-api.{region}.amazonaws.com titik akhir default. Untuk mengharuskan klien menggunakan nama domain khusus untuk memanggil API Anda, tent true ukan.
vpcEndpointIds Sebuah array String

Daftar pengi VpcEndpoint dentifikasi yang digunakan untuk membuat catatan alias Route 53 untuk REST API. Ini hanya didukung untuk REST API tipe PRIVATE titik akhir.
ipAddressType string

Jenis alamat IP yang dapat memanggil API HTTP. Gunakan ipv4 untuk mengizinkan jenis alamat IPv4 untuk memanggil API HTTP. Gunakan dualstack untuk mengizinkan jenis alamat IPv4 dan IPv6 untuk memanggil API HTTP. Ini hanya didukung untuk API HTTP.

contoh konfigurasi x-amazon-apigateway-endpoint-

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
}

Contoh berikut menetapkan jenis alamat IP ke dualstack untuk API HTTP.

"x-amazon-apigateway-endpoint-configuration": {
    "ipAddressType": "dualstack"
}