Nama domain khusus untuk API HTTP di API Gateway

Nama domain khusus adalah URL yang lebih sederhana dan lebih intuitif yang dapat Anda berikan kepada pengguna API Anda.

Setelah menerapkan API, Anda (dan pelanggan) dapat menjalankan API menggunakan URL dasar default dari format berikut:

https://api-id.execute-api.region.amazonaws.com/stage

di mana api-id dihasilkan oleh API Gateway, wilayah adalah AWS Wilayah, dan tahap ditentukan oleh Anda saat menerapkan API.

Bagian nama host dari URL, api-id.execute-api.region.amazonaws.com mengacu pada titik akhir API. Nama endpoint API default dibuat secara acak, sulit diingat, dan tidak ramah pengguna.

Dengan nama domain khusus, Anda dapat mengatur nama host API Anda, dan memilih jalur dasar (misalnya,myservice) untuk memetakan URL alternatif ke API Anda. Misalnya, URL dasar API yang lebih ramah pengguna dapat menjadi:

https://api.example.com/myservice

Pertimbangan

Pertimbangan berikut dapat memengaruhi penggunaan nama domain khusus Anda.

• Nama domain kustom Regional dapat dikaitkan dengan REST API dan HTTP API. Anda dapat menggunakan API Gateway Versi 2 API untuk membuat dan mengelola nama domain kustom Regional untuk REST API.

• Untuk versi TLS minimum, hanya TLS 1.2 yang didukung.

• Anda harus membuat atau memperbarui catatan sumber daya penyedia DNS Anda untuk memetakan ke titik akhir API Anda. Tanpa pemetaan seperti itu, permintaan API yang terikat untuk nama domain khusus tidak dapat mencapai API Gateway.

• Anda dapat mendukung jumlah nama domain yang hampir tak terbatas tanpa melebihi kuota default dengan menggunakan sertifikat wildcard. Untuk informasi selengkapnya, lihat Nama domain kustom wildcard.

Prasyarat

Berikut ini adalah prasyarat untuk membuat nama domain khusus.

Daftarkan nama domain

Anda harus memiliki nama domain internet terdaftar untuk menyiapkan nama domain khusus untuk API Anda. Anda dapat mendaftarkan nama domain internet Anda menggunakan Amazon Route 53 atau menggunakan registrar domain pihak ketiga pilihan Anda. Nama domain kustom Anda dapat berupa nama subdomain atau domain root (juga dikenal sebagai “zone apex”) dari domain internet terdaftar.

Nama domain Anda harus mengikuti spesifikasi RFC 1035 dan dapat memiliki maksimum 63 oktet per label dan total 255 oktet.

Sertifikat untuk nama domain khusus

Sebelum menyiapkan nama domain khusus untuk API, Anda harus memiliki sertifikat SSL/TLS yang siap di ACM. Jika ACM tidak tersedia di AWS Wilayah tempat Anda membuat nama domain kustom, Anda harus mengimpor sertifikat ke API Gateway di Wilayah tersebut.

Untuk mengimpor sertifikat SSL/TLS, Anda harus menyediakan badan sertifikat SSL/TLS yang diformat PEM, kunci pribadinya, dan rantai sertifikat untuk nama domain kustom.

Setiap sertifikat yang disimpan dalam ACM diidentifikasi oleh ARN-nya. Dengan sertifikat yang dikeluarkan oleh ACM, Anda tidak perlu khawatir mengekspos detail sertifikat sensitif, seperti kunci pribadi. Untuk menggunakan sertifikat AWS terkelola untuk nama domain, Anda cukup mereferensikan ARN-nya.

Jika aplikasi Anda menggunakan pinning sertifikat, kadang-kadang dikenal sebagai penyematan SSL, untuk menyematkan sertifikat ACM, aplikasi mungkin tidak dapat terhubung ke domain Anda setelah AWS memperbarui sertifikat. Untuk informasi selengkapnya, lihat Masalah penyematan sertifikat di Panduan AWS Certificate Manager Pengguna.

Nama domain kustom wildcard

Dengan nama domain khusus wildcard, Anda dapat mendukung jumlah nama domain yang hampir tak terbatas tanpa melebihi kuota default. Misalnya, Anda bisa memberi setiap pelanggan Anda nama domain mereka sendiricustomername.api.example.com.

Untuk membuat nama domain kustom wildcard, tentukan wildcard (*) sebagai subdomain pertama dari domain kustom yang mewakili semua kemungkinan subdomain dari domain root.

Misalnya, nama domain kustom wildcard *.example.com menghasilkan subdomain sepertia.example.com,, dan b.example.comc.example.com, yang semuanya merutekan ke domain yang sama.

Nama domain kustom wildcard mendukung konfigurasi yang berbeda dari nama domain kustom standar API Gateway. Misalnya, dalam satu AWS akun, Anda dapat mengkonfigurasi *.example.com dan a.example.com berperilaku berbeda.

Untuk membuat nama domain kustom wildcard, Anda harus memberikan sertifikat yang dikeluarkan oleh ACM yang telah divalidasi menggunakan DNS atau metode validasi email.

catatan

Anda tidak dapat membuat nama domain khusus wildcard jika AWS akun lain telah membuat nama domain kustom yang bertentangan dengan nama domain kustom wildcard. Misalnya, jika akun A telah dibuata.example.com, maka akun B tidak dapat membuat nama *.example.com domain khusus wildcard.

Jika akun A dan akun B berbagi pemilik, Anda dapat menghubungi Pusat AWS Dukungan untuk meminta pengecualian.

Langkah selanjutnya untuk nama domain khusus

Untuk menyiapkan nama domain kustom untuk API HTTP, Anda menggunakan dokumentasi dari bagian REST API dari Panduan Pengembang API Gateway.

Pertama, tentukan sertifikat untuk nama domain kustom Anda. Untuk informasi selengkapnya, lihat Siapkan sertifikat AWS Certificate Manager. Selanjutnya, Anda membuat nama domain kustom Regional. Untuk informasi selengkapnya, lihat Menyiapkan nama domain kustom Regional di API Gateway.