ApiUsagePlan

Mengonfigurasi rencana penggunaan untuk API dari API Gateway. Untuk informasi selengkapnya tentang rencana penggunaan, lihat Buat dan Gunakan Rencana Penggunaan dengan Kunci API di Panduan Developer API Gateway.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  CreateUsagePlan: String
  Description: String
  Quota: QuotaSettings
  Tags: List
  Throttle: ThrottleSettings
  UsagePlanName: String

Properti

CreateUsagePlan

Menentukan cara rencana penggunaan ini dikonfigurasi. Nilai yang valid adalah PER_API, SHARED, dan NONE.

PER_APImembuat AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey, dan AWS::ApiGateway::UsagePlanKeysumber daya yang khusus untuk API ini. Masing-masing sumber daya ini memiliki ID logis <api-logical-id>UsagePlan, <api-logical-id>ApiKey, dan <api-logical-id>UsagePlanKey.

SHAREDmembuat AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey, dan AWS::ApiGateway::UsagePlanKeysumber daya yang dibagikan di seluruh API apa pun yang juga ada CreateUsagePlan: SHARED di AWS SAM template yang sama. Masing-masing sumber daya ini memiliki ID logis ServerlessUsagePlan, ServerlessApiKey, dan ServerlessUsagePlanKey. Jika Anda menggunakan opsi ini, kami sarankan Anda menambahkan konfigurasi tambahan untuk rencana penggunaan ini hanya pada satu sumber daya API untuk menghindari ketentuan yang bertentangan dan keadaan tidak pasti.

NONE menonaktifkan pembuatan atau asosiasi rencana penggunaan dengan API ini. Ini hanya diperlukan jika SHARED atau PER_API ditentukan dalam Bagian global dari templat AWS SAM.

Nilai yang valid adalah : PER_API, SHARED, and NONE

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Description

Deskripsi rencana penggunaan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Description properti AWS::ApiGateway::UsagePlan sumber daya.

Quota

Mengonfigurasi jumlah permintaan yang dapat dibuat pengguna dalam interval tertentu.

Jenis: QuotaSettings

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Quota properti AWS::ApiGateway::UsagePlan sumber daya.

Tags

Susunan tanda bebas (pasangan nilai kunci) untuk mengaitkan dengan rencana penggunaan.

Properti ini menggunakan Jenis CloudFormation Tag.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Tags properti AWS::ApiGateway::UsagePlan sumber daya.

Throttle

Mengonfigurasi laju permintaan keseluruhan (permintaan rata-rata per detik) dan kapasitas lonjakan.

Jenis: ThrottleSettings

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Throttle properti AWS::ApiGateway::UsagePlan sumber daya.

UsagePlanName

Sebuah nama untuk rencana penggunaan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke UsagePlanName properti AWS::ApiGateway::UsagePlan sumber daya.

Contoh

UsagePlan

Berikut ini adalah contoh rencana penggunaan.

YAML

Auth:
  UsagePlan:
    CreateUsagePlan: PER_API
    Description: Usage plan for this API
    Quota:
      Limit: 500
      Period: MONTH
    Throttle:
      BurstLimit: 100
      RateLimit: 50
    Tags:
      - Key: TagName
        Value: TagValue