Menyiapkan nama domain kustom Regional di API Gateway

Gunakan nama domain kustom Regional untuk membuat URL dasar API yang mudah digunakan. Dengan nama domain kustom Regional, Anda dapat memetakan tahap HTTP dan REST API ke nama domain kustom yang sama dan menggunakan otentikasi TLS bersama.

Pertimbangan

Berikut ini adalah pertimbangan untuk nama domain kustom Regional Anda.

• Anda harus memberikan sertifikat ACM khusus Wilayah. Sertifikat ini harus berada di Wilayah yang sama dengan API Anda. Untuk informasi selengkapnya tentang membuat atau mengunggah sertifikat nama domain kustom, lihatSiapkan sertifikat AWS Certificate Manager.

• Saat Anda membuat nama domain kustom Regional (atau memigrasikan satu) dengan sertifikat ACM, API Gateway akan membuat peran terkait layanan di akun Anda. Peran terkait layanan diperlukan untuk melampirkan sertifikat ACM Anda ke titik akhir Regional Anda. Peran diberi nama AWSServiceRoleForAPIGatewaydan akan memiliki kebijakan GatewayServiceRolePolicy terkelola API yang dilampirkan padanya. Untuk informasi selengkapnya tentang penggunaan peran terkait layanan, lihat Menggunakan Peran Tertaut Layanan.

• Setelah Anda membuat nama domain kustom Regional Anda, Anda harus membuat catatan DNS untuk mengarahkan nama domain kustom ke nama domain Regional. Hal ini memungkinkan lalu lintas yang terikat pada nama domain kustom untuk dirutekan ke nama host Regional API. Catatan DNS dapat berupa tipe CNAME atau “A”.

Buat nama domain kustom Regional

Prosedur berikut menunjukkan cara membuat nama domain kustom Regional. Setelah Anda menyelesaikan prosedur ini, Anda harus membuat catatan DNS untuk mengarahkan nama domain kustom ke nama domain Regional.

AWS Management Console

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

2. Pilih Nama domain khusus dari panel navigasi utama.

3. Pilih Buat.

4. Untuk nama Domain, masukkan nama domain.

5. Di bawah Konfigurasi, pilih Regional.

6. Pilih versi TLS minimum.

7. Pilih sertifikat ACM. Sertifikat harus berada di Wilayah yang sama dengan API.

8. Pilih Buat.

AWS CLI

create-domain-namePerintah berikut dapat digunakan untuk membuat nama domain kustom:

aws apigatewayv2 create-domain-name \ 
    --domain-name 'regional.example.com' \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

Jika berhasil, panggilan mengembalikan hasil yang mirip dengan berikut ini:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "regional.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "DomainNameStatus": "AVAILABLE",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "Z2OJLYMUO9EFXC",
            "SecurityPolicy": "TLS_1_2"
        }
    ]
}

Nilai DomainNameConfigurations properti mengembalikan nama host API Regional. Anda harus membuat catatan DNS untuk mengarahkan nama domain kustom Anda ke nama domain Regional ini. Ini memungkinkan lalu lintas yang terikat pada nama domain kustom untuk dirutekan ke nama host API Regional ini.

Buat catatan DNS untuk nama domain kustom Regional Anda

Prosedur berikut menunjukkan cara membuat catatan DNS untuk mengarahkan nama domain kustom Anda nama domain Regional yang baru dibuat.

AWS Management Console

Untuk menggunakan AWS Management Console, ikuti dokumentasi Route 53 tentang mengonfigurasi Route 53 untuk merutekan lalu lintas ke API Gateway.

AWS CLI

Untuk mengonfigurasi catatan DNS Anda untuk memetakan nama domain kustom Regional ke nama hostnya dari ID zona host yang diberikan, pertama-tama buat file JSON yang berisi konfigurasi untuk menyiapkan catatan DNS untuk nama domain Regional.

Berikut ini setup-dns-record.json menunjukkan cara membuat A catatan DNS untuk memetakan nama domain kustom Regional (regional.example.com) ke nama host Regional (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) yang disediakan sebagai bagian dari pembuatan nama domain kustom. HostedZoneIdProperti DNSName dan AliasTarget dapat mengambil regionalHostedZoneId nilai regionalDomainName dan, masing-masing, dari nama domain kustom. Anda juga bisa mendapatkan ID Zona Dihosting Route 53 Regional di Titik Akhir dan Kuota Amazon API Gateway.

{
  "Changes": [
    {
      "Action": "CREATE",
      "ResourceRecordSet": {
        "Name": "regional.example.com",
        "Type": "A",
        "AliasTarget": {
          "DNSName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com",
          "HostedZoneId": "Z2OJLYMUO9EFXC",
          "EvaluateTargetHealth": false
        }
      }
    }
  ]
}

Berikut ini change-resource-record-setsmenunjukkan cara membuat data DNS untuk nama domain kustom Regional Anda:

aws route53 change-resource-record-sets \
    --hosted-zone-id Z2OJLYMUO9EFXC \
    --change-batch file://path/to/your/setup-dns-record.json

Ganti hosted-zone-id dengan ID Zona Dihosting Route 53 dari catatan DNS yang ditetapkan di akun Anda. Nilai change-batch parameter menunjuk ke file JSON (setup-dns-record.json) dalam folder (path/to/your).

Buat pemetaan jalur dasar untuk nama domain kustom Regional Anda

Setelah Anda membuat catatan DNS, Anda membuat pemetaan jalur dasar untuk memetakan API Anda ke nama domain kustom. Misalnya, Anda dapat memetakan tahap test untuk ID API abc123 ke nama domain kustom regional.example.com menggunakan kunci pemetaan API. myApi Ini memetakan API https://abcd1234.execute-api.us-west-2.amazonaws.com/test kehttps://regional.example.com/myApi.

AWS Management Console

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

2. Pilih nama domain khusus.

3. Pilih Konfigurasi pemetaan API.

4. Pilih Tambahkan pemetaan baru.

5. Tentukan API, Stage, dan Path untuk pemetaan.

6. Pilih Simpan.

AWS CLI

create-api-mappingPerintah berikut dapat digunakan untuk membuat pemetaan jalur dasar:

aws apigatewayv2 create-api-mapping \
    --domain-name 'regional.example.com' \
    --api-mapping-key 'myApi' \
    --api-id abcd1234 \
    --stage 'test'

Akibatnya, URL dasar yang menggunakan nama domain khusus untuk API yang diterapkan di panggung menjadihttps://regional.example.com/myAPI.

Dengan nama domain kustom Regional, Anda dapat membuat pemetaan API dengan beberapa level, sepertihttps://regional.example.com/orders/v1/items/123. Anda juga dapat memetakan tahap HTTP dan REST API ke nama domain kustom yang sama. Untuk informasi selengkapnya, lihat Memetakan tahapan API ke nama domain khusus.