Memantau konfigurasi API Gateway API denganAWS Config - Amazon API Gateway
Jenis sumber daya yang mendukungMenyiapkan AWS ConfigMengkonfigurasiAWS Config untuk merekam sumber daya API GatewayMelihat detail konfigurasi API Gateway diAWS Config konsolMengevaluasi sumber daya API Gateway menggunakanAWS Config aturan

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

Memantau konfigurasi API Gateway API denganAWS Config

Anda dapat menggunakan AWS Configuntuk mencatat perubahan konfigurasi yang dibuat ke sumber daya API Gateway API Anda dan mengirim notifikasi berdasarkan perubahan sumber daya. Mempertahankan riwayat perubahan konfigurasi untuk sumber daya API Gateway berguna untuk pemecahan masalah operasional, audit, dan kasus penggunaan kepatuhan.

AWS Configdapat melacak perubahan ke:

  • Konfigurasi tahap API, seperti:

    • pengaturan klaster cache

    • pengaturan throttle

    • pengaturan log akses

    • penyebaran aktif yang ditetapkan di atas panggung

  • Konfigurasi API, seperti:

    • konfigurasi endpoint

    • versi

    • protokol

    • tag

Selain itu,Aturan AWS Config fitur ini memungkinkan Anda untuk menentukan aturan konfigurasi dan secara otomatis mendeteksi, melacak, dan memperingatkan pelanggaran terhadap aturan ini. Dengan melacak perubahan pada properti konfigurasi sumber daya ini, Anda juga dapat membuatAWS Config aturan yang dipicu perubahan untuk sumber daya API Gateway, dan menguji konfigurasi sumber daya Anda terhadap praktik terbaik.

Anda dapat mengaktifkanAWS Config di akun Anda dengan menggunakanAWS Config konsol atauAWS CLI. Pilih jenis sumber daya yang ingin Anda lacak perubahannya. Jika sebelumnya Anda mengonfigurasiAWS Config untuk merekam semua jenis sumber daya, maka sumber daya API Gateway ini akan direkam secara otomatis di akun Anda. Support untuk Amazon API GatewayAWS Config tersedia di semua wilayahAWS publik danAWS GovCloud (US). Untuk daftar lengkap Wilayah yang didukung, lihat Endpoint dan Kuota Amazon API Gateway diReferensi Umum AWS.

Jenis sumber daya yang mendukung

Jenis sumber daya API Gateway berikut terintegrasi denganAWS Config dan didokumentasikan dalam JenisAWS Sumber DayaAWS Config yang Didukung dan Hubungan Sumber Daya:

  • AWS::ApiGatewayV2::Api(WebSocketdan HTTP API)

  • AWS::ApiGateway::RestApi(API ISTIRAHAT)

  • AWS::ApiGatewayV2::Stage(WebSocketdan tahap API HTTP)

  • AWS::ApiGateway::Stage(Tahap API REST)

Untuk informasi tentang AWS Config, lihat Panduan Developer AWS Config. Untuk informasi harga, lihat halaman informasi harga AWS Config.

penting

Jika Anda mengubah salah satu properti API berikut setelah API diterapkan, Anda harus men-deploy ulang API untuk menyebarkan perubahan. Jika tidak, Anda akan melihat perubahan atribut diAWS Config konsol, tetapi pengaturan properti sebelumnya akan tetap berlaku; perilaku runtime API tidak akan berubah.

  • AWS::ApiGateway::RestApi – binaryMediaTypes, minimumCompressionSize, apiKeySource

  • AWS::ApiGatewayV2::Api – apiKeySelectionExpression

Menyiapkan AWS Config

Untuk menyiapkan AWS Config, lihat topik berikut dalam Panduan Developer AWS Config.

MengkonfigurasiAWS Config untuk merekam sumber daya API Gateway

Secara default,AWS Config mencatat perubahan konfigurasi untuk semua jenis yang didukung sumber daya regional yang ditemukan di wilayah di mana lingkungan Anda berjalan. Anda dapat menyesuaikanAWS Config untuk mencatat perubahan hanya untuk jenis sumber daya tertentu, atau perubahan ke sumber daya global.

Untuk mempelajari tentang sumber daya regional vs global dan mempelajari cara menyesuaikanAWS Config konfigurasi Anda, lihat MemilihAWS Config Rekaman Sumber Daya yang mana.

Melihat detail konfigurasi API Gateway diAWS Config konsol

Anda dapat menggunakanAWS Config konsol untuk mencari sumber daya API Gateway dan mendapatkan rincian saat ini dan sejarah tentang konfigurasi mereka. Prosedur berikut menunjukkan cara menemukan informasi tentang API Gateway API.

Untuk menemukan sumber daya API Gateway di konsolAWS konfigurasi

  1. Buka konsol AWS Config.

  2. Pilih Sumber Daya.

  3. Pada halamanInventarisasi sumber daya, pilih Sumber Daya.

  4. Buka menu Jenis sumber daya, gulir ke Apigateway atau Apigatewayv2, dan kemudian pilih satu atau lebih dari jenis sumber daya API Gateway.

  5. Pilih Lihat.

  6. Pilih ID sumber daya dalam daftar sumber daya yangAWS Config tampilkan. AWS Configmenampilkan rincian konfigurasi dan informasi lainnya tentang sumber daya yang Anda pilih.

  7. Untuk melihat detail lengkap konfigurasi yang direkam, pilih Lihat Detail.

Untuk mempelajari lebih lanjut cara menemukan sumber daya dan melihat informasi di halaman ini, lihat Melihat KonfigurasiAWS Sumber Daya dan Sejarah dalam PanduanAWS Config Developer.

Mengevaluasi sumber daya API Gateway menggunakanAWS Config aturan

Anda dapat membuatAWS Config aturan, yang mewakili pengaturan konfigurasi yang ideal untuk sumber daya API Gateway Anda. Anda dapat menggunakan AturanAWS Config Terkelola yang telah ditetapkan, atau menentukan aturan khusus. AWS Configterus melacak perubahan pada konfigurasi sumber daya Anda untuk menentukan apakah perubahan tersebut melanggar salah satu syarat dalam aturan Anda. Konsol AWS Config menunjukkan status kepatuhan aturan dan sumber daya Anda.

Jika sumber daya melanggar aturan dan ditandai sebagai tidak patuh,AWS Config dapat mengingatkan Anda menggunakan topik Amazon Simple Notification Service (Amazon SNS). Untuk pemrograman mengonsumsi data dalamAWS Config peringatan, gunakan antrian Amazon Simple Queue Service (Amazon SQS) sebagai titik akhir pemberitahuan untuk topik Amazon SNS.

Untuk mempelajari lebih lanjut tentang menyiapkan dan menggunakan aturan, lihat Mengevaluasi Sumber daya dengan Aturan dalam PanduanAWS Config Developer.