Memetakan tahapan API ke nama domain khusus untuk WebSocket APIs

Anda menggunakan pemetaan API untuk menghubungkan tahapan API ke nama domain kustom. Setelah Anda membuat nama domain dan mengonfigurasi catatan DNS, Anda menggunakan pemetaan API untuk mengirim lalu lintas ke Anda APIs melalui nama domain kustom Anda.

Pemetaan API menentukan API, tahap, dan jalur opsional yang akan digunakan untuk pemetaan. Misalnya, Anda dapat memetakan production tahap API kewss://api.example.com/orders.

Sebelum membuat pemetaan API, Anda harus memiliki API, panggung, dan nama domain khusus. Untuk mempelajari selengkapnya tentang membuat nama domain kustom, lihatMenyiapkan nama domain kustom Regional di API Gateway.

Pembatasan

• Dalam pemetaan API, nama domain khusus dan dipetakan APIs harus berada di akun yang sama AWS .

• Pemetaan API harus hanya berisi huruf, angka, dan karakter berikut:. $-_.+!*'()

• Panjang maksimum jalur dalam pemetaan API adalah 300 karakter.

• Anda tidak dapat memetakan WebSocket APIs ke nama domain kustom yang sama dengan HTTP API atau REST API.

• Jika Anda membuat pemetaan API dengan beberapa level, API Gateway mengonversi semua nama header menjadi huruf kecil.

Buat pemetaan API

Untuk membuat pemetaan API, Anda harus terlebih dahulu membuat nama domain kustom, API, dan stage. Untuk informasi tentang membuat nama domain kustom, lihatMenyiapkan nama domain kustom Regional di API Gateway.

AWS Management Console

Untuk membuat pemetaan API

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Pilih Nama domain khusus.

3. Pilih nama domain khusus yang telah Anda buat.

4. Pilih pemetaan API.

5. Pilih Konfigurasi pemetaan API.

6. Pilih Tambahkan pemetaan baru.

7. Masukkan API, Stage, dan secara opsional Path.

8. Pilih Simpan.

AWS CLI

create-api-mappingPerintah berikut membuat pemetaan API. Dalam contoh ini, API Gateway mengirimkan permintaan api.example.com/v1 ke API dan tahap yang ditentukan.

aws apigatewayv2 create-api-mapping \
    --domain-name api.example.com \
    --api-mapping-key v1 \
    --api-id a1b2c3d4 \
    --stage test

AWS CloudFormation

AWS CloudFormation Contoh berikut membuat pemetaan API.

MyApiMapping:
  Type: 'AWS::ApiGatewayV2::ApiMapping'
  Properties:
    DomainName: api.example.com
    ApiMappingKey: 'v1'
    ApiId: !Ref MyApi
    Stage: !Ref MyStage