ApiUsagePlan

Konfiguriert einen Nutzungsplan für eine API-Gateway-API. Weitere Informationen zu Nutzungsplänen finden Sie unter Nutzungspläne mit API-Schlüsseln erstellen und verwenden im API Gateway Developer Guide.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

YAML

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

Eigenschaften

CreateUsagePlan

Legt fest, wie dieser Nutzungsplan konfiguriert ist. Gültige Werte sind PER_API, SHARED und NONE.

PER_APIerstellt AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey, und AWS::ApiGateway::UsagePlanKeyRessourcen, die für diese API spezifisch sind. Diese Ressourcen haben jeweils die logischen IDs <api-logical-id>UsagePlan <api-logical-id>ApiKey<api-logical-id>UsagePlanKey, und.

SHAREDerstellt AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey, und AWS::ApiGateway::UsagePlanKeyRessourcen, die von allen APIs gemeinsam genutzt werden, die auch CreateUsagePlan: SHARED in derselben AWS SAM Vorlage enthalten sind. Diese Ressourcen haben jeweils die logischen IDs ServerlessUsagePlan ServerlessApiKeyServerlessUsagePlanKey, und. Wenn Sie diese Option verwenden, empfehlen wir, zusätzliche Konfigurationen für diesen Nutzungsplan nur für eine API-Ressource hinzuzufügen, um widersprüchliche Definitionen und einen unsicheren Status zu vermeiden.

NONEdeaktiviert die Erstellung oder Verknüpfung eines Nutzungsplans mit dieser API. Dies ist nur erforderlich, wenn SHARED oder in der Globaler Abschnitt der AWS SAM Vorlage angegeben PER_API ist.

Zulässige Werte: PER_API, SHARED und NONE

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Description

Eine Beschreibung des Nutzungsplans.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Description Eigenschaft einer AWS::ApiGateway::UsagePlan Ressource übergeben.

Quota

Konfiguriert die Anzahl von Anforderungen, die Benutzer innerhalb eines bestimmten Intervalls vornehmen können.

Typ: QuotaSettings

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Quota Eigenschaft einer AWS::ApiGateway::UsagePlan Ressource übergeben.

Tags

Ein Array an beliebigen Tags (Schlüssel-Wert-Paaren), die dem Nutzungsplan zugewiesen werden sollen.

Diese Eigenschaft verwendet den CloudFormation Tag-Typ.

Typ: Liste

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Tags Eigenschaft einer AWS::ApiGateway::UsagePlan Ressource übergeben.

Throttle

Konfiguriert die gesamte Anforderungsrate (durchschnittliche Anforderungen pro Sekunde) und die Steigerungskapazität.

Typ: ThrottleSettings

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Throttle Eigenschaft einer AWS::ApiGateway::UsagePlan Ressource übergeben.

UsagePlanName

Ein Name für den Nutzungsplan.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die UsagePlanName Eigenschaft einer AWS::ApiGateway::UsagePlan Ressource übergeben.

Beispiele

UsagePlan

Das Folgende ist ein Beispiel für einen Nutzungsplan.

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