ApiUsagePlan

Configura un piano di utilizzo per un'API API Gateway. Per ulteriori informazioni sui piani di utilizzo, consultaCreazione e utilizzo dei piani di utilizzo con chiavi APInellaGuida per sviluppatori di API Gateway.

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la seguente sintassi.

YAML

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

Proprietà

CreateUsagePlan

Determina come è configurato questo piano di utilizzo. I valori validi sono PER_API, SHARED e NONE.

PER_APIcreaAWS::ApiGateway::UsagePlan,AWS::ApiGateway::ApiKey, eAWS::ApiGateway::UsagePlanKeyrisorse specifiche per questa API. Queste risorse hanno ID logici di<api-logical-id>UsagePlan,<api-logical-id>ApiKey, e<api-logical-id>UsagePlanKey, rispettivamente.

SHAREDcreaAWS::ApiGateway::UsagePlan,AWS::ApiGateway::ApiKey, eAWS::ApiGateway::UsagePlanKeyrisorse condivise su qualsiasi API che abbiaCreateUsagePlan: SHAREDnello stessoAWS SAMmodello di. Queste risorse hanno ID logici diServerlessUsagePlan,ServerlessApiKey, eServerlessUsagePlanKey, rispettivamente. Se si utilizza questa opzione, si consiglia di aggiungere una configurazione aggiuntiva per questo piano di utilizzo su una sola risorsa API per evitare definizioni in conflitto e uno stato incerto.

NONEdisabilita la creazione o l'associazione di un piano di utilizzo con questa API. Ciò è necessario solo seSHAREDoPER_APIè specificato nelSezione Globals delAWS SAM modello.

Valori validi: PER_API, SHARED e NONE

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà è unica perAWS SAMe non dispone diAWS CloudFormationequivalente.

Description

Una descrizione del piano di utilizzo.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alDescriptionproprietà di unAWS::ApiGateway::UsagePlanrisorsa.

Quota

Consente di configurare il numero di richieste che possono essere eseguite dagli utenti in un determinato intervallo.

Type: QuotaSettings

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alQuotaproprietà di unAWS::ApiGateway::UsagePlanrisorsa.

Tags

Un array di tag arbitrari (coppie chiave-valore) da associare al piano di utilizzo.

Questa proprietà utilizza ilTipo di tag CloudFormation.

Type: Elenco

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alTagsproprietà di unAWS::ApiGateway::UsagePlanrisorsa.

Throttle

Consente di configurare il tasso di richiesta complessivo (richieste medie al secondo) e la capacità di ottimizzazione.

Type: ThrottleSettings

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alThrottleproprietà di unAWS::ApiGateway::UsagePlanrisorsa.

UsagePlanName

Un nome per il piano di utilizzo.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alUsagePlanNameproprietà di unAWS::ApiGateway::UsagePlanrisorsa.

Esempi

UsagePlan

Di seguito è riportato un esempio di piano di utilizzo.

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