Tutorial: Membuat dan memanggil nama domain khusus untuk API pribadi

API Gateway menyediakan nama domain dengan kebijakan deny semua sumber daya. Ini adalah kebijakan sumber daya untuk execute-api layanan. Anda perlu memperbarui kebijakan sumber daya ini untuk memberikan akses ke titik akhir VPC Anda untuk memanggil nama domain kustom pribadi Anda.

Saat Anda membuat nama domain kustom pribadi menggunakan AWS CLI, Anda memberikan kebijakan sumber daya untuk execute-api layanan untuk memberikan akses ke titik akhir VPC untuk memanggil nama domain kustom pribadi Anda, menggunakan parameter. --policy file://policy.json Anda dapat mengubah kebijakan ini nanti.

Untuk contoh ini, Anda akan melampirkan kebijakan sumber daya berikut sebagai parameter policy dengan memuat dari file. Salin dan simpan file ini sebagaipolicy.json. Kebijakan ini hanya mengizinkan lalu lintas masuk ke nama domain kustom pribadi dari titik akhir VPC: vpce-abcd1234efg

Perintah create-domain-name berikut membuat nama domain kustom pribadi:

aws apigateway create-domain-name \
    --domain-name 'private.example.com' \
    --certificate-arn 'arn:aws:acm:us-west-2:111122223333:certificate/a1b2c3d4-5678-90ab-cdef' \
    --security-policy 'TLS_1_2' \
    --endpoint-configuration '{"types":["PRIVATE"]}' \
    --policy file://policy.json

Outputnya akan seperti berikut ini.

{
    "domainName": "private.example.com",
    "domainNameId": "abcd1234",
    "domainNameArn": "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234",
    "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/a1b2c3d4-5678-90ab-cdef",
    "certificateUploadDate": "2024-09-10T10:31:20-07:00",
    "endpointConfiguration": {
        "types": [
            "PRIVATE"
        ]
    },
    "domainNameStatus": "AVAILABLE",
    "securityPolicy": "TLS_1_2",
    "routingMode" : "API_MAPPING_ONLY",
    "policy": "..."
}

Perintah create-base-path-mapping berikut membuat pemetaan antara API pribadi dan nama domain kustom pribadi:

aws apigateway create-base-path-mapping \
    --domain-name-id abcd1234 \
    --domain-name 'private.example.com' \
    --rest-api-id a1b2c3 \
    --stage prod \
    --base-path v1

Outputnya akan terlihat seperti berikut ini.

{
    "basePath": "v1",
    "restApiId": "a1b2c3",
    "stage": "prod"
}

Anda juga dapat membuat asosiasi akses nama domain menggunakan halaman asosiasi akses nama domain di konsol.

Per create-domain-name-access-association intah berikut membuat asosiasi akses nama domain antara nama domain kustom pribadi Anda dan titik akhir VPC Anda.

aws apigateway create-domain-name-access-association \
    --domain-name-arn arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234 \
    --access-association-source vpce-abcd1234efg \
    --access-association-source-type VPCE \
    --region us-west-2

Outputnya akan terlihat seperti berikut ini.

{
    "domainNameAccessAssociationARN": "arn:aws:apigateway:us-west-2:111122223333:/domainnameaccessassociations/domainname/private.example.com+abcd1234/vpcesource/vpce-abcd1234efg",
    "accessAssociationSource": "vpce-abcd1234efg",
    "accessAssociationSourceType": "VPCE",
    "domainNameARN" : "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234"
}

Untuk menggunakan Konsol Manajemen AWS, lihat Membuat zona yang dihosting pribadi di Panduan Pengembang Amazon Route 53.

Untuk Nama, gunakan nama nama domain kustom pribadi Anda. Untuk ID VPC, gunakan VPC yang berisi titik akhir VPC yang Anda gunakan pada langkah sebelumnya.

Perintah create-hosted-zone berikut membuat zona host pribadi:

aws route53 create-hosted-zone --name private.example.com \
    --caller-reference 2014-04-01-18:47 \
    --hosted-zone-config Comment="command-line version",PrivateZone=true \
    --vpc VPCRegion=us-west-2,VPCId=vpc-abcd1234

Output berisi ID zona yang dihosting. Anda menggunakan ID zona yang dihosting dalam langkah-langkah berikut.

Untuk menggunakan Konsol Manajemen AWS, lihat Mer utekan lalu lintas ke API Gateway API Amazon dengan menggunakan nama domain Anda.

Gunakan Quick create dan aktifkan Alias. Untuk titik akhir, gunakan nama DNS titik akhir VPC.

Untuk mengonfigurasi catatan DNS Anda untuk memetakan nama domain kustom pribadi ke nama host dari ID zona yang dihosting yang diberikan, Anda membuat file JSON yang berisi konfigurasi untuk menyiapkan catatan DNS untuk nama domain pribadi.

Berikut ini setup-dns-record.json menunjukkan cara membuat A catatan DNS untuk memetakan nama domain kustom pribadi ke nama host pribadinya. Anda memberikan ID DNS VPC Anda, dan ID zona yang dihosting yang Anda buat pada langkah sebelumnya. DNSName

{
  "Changes": [
    {
      "Action": "UPSERT",
      "ResourceRecordSet": {
        "Name": "private.example.com",
        "Type": "A",
        "AliasTarget": {
          "DNSName": "vpce-abcd1234.execute-api.us-west-2.vpce.amazonaws.com",
          "HostedZoneId": "Z2OJLYMUO9EFXC",
          "EvaluateTargetHealth": false
        }
      }
    }
  ]
}

Perintah change-resource-record-sets berikut membuat catatan DNS untuk nama domain kustom pribadi Anda:

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

Ganti hosted-zone-id dengan ID Zona Hosted Route 53 dari catatan DNS yang ditetapkan di akun Anda. Nilai change-batch parameter menunjuk ke file JSON.

Setelah menghapus asosiasi akses nama domain, Anda dapat menghapus nama domain kustom pribadi Anda.

Jika perlu, Anda juga dapat menghapus titik akhir VPC Anda. Untuk informasi selengkapnya, lihat Menghapus titik akhir antarmuka.

Jika perlu, Anda juga dapat menghapus titik akhir VPC Anda. Untuk informasi selengkapnya, lihat Menghapus titik akhir antarmuka.