ApiUsagePlan

Configura un piano di utilizzo per un'API API Gateway. Per ulteriori informazioni sui piani di utilizzo, consulta Creare e utilizzare piani di utilizzo con chiavi API nella Guida per sviluppatori di API Gateway.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa 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_APIcrea AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKeye AWS::ApiGateway::UsagePlanKeyrisorse specifiche per questa API. Queste risorse hanno ID logici rispettivamente di <api-logical-id>UsagePlan <api-logical-id>ApiKey<api-logical-id>UsagePlanKey, e.

SHAREDcrea AWS::ApiGateway::UsagePlane AWS::ApiGateway::UsagePlanKeyrisorse condivise tra qualsiasi API che include CreateUsagePlan: SHARED anche lo stesso AWS SAM modello. AWS::ApiGateway::ApiKey Queste risorse hanno ID logici rispettivamente di ServerlessUsagePlan ServerlessApiKeyServerlessUsagePlanKey, e. 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 contrastanti e uno stato incerto.

NONEdisabilita la creazione o l'associazione di un piano di utilizzo con questa API. Ciò è necessario solo se SHARED o PER_API è specificato in. Sezione Globals del modello AWS SAM

Valori validi: PER_API, SHARED e NONE

▬Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormation compatibilità: Questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Description

Una descrizione del piano di utilizzo.

▬Tipo: stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Description proprietà di una AWS::ApiGateway::UsagePlan risorsa.

Quota

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

Tipo: QuotaSettings

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Quota proprietà di una AWS::ApiGateway::UsagePlan risorsa.

Tags

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

Questa proprietà utilizza il tipo di CloudFormation tag.

Tipo: Elenco

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Tags proprietà di una AWS::ApiGateway::UsagePlan risorsa.

Throttle

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

Tipo: ThrottleSettings

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Throttle proprietà di una AWS::ApiGateway::UsagePlan risorsa.

UsagePlanName

Un nome per il piano di utilizzo.

▬Tipo: stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla UsagePlanName proprietà di una AWS::ApiGateway::UsagePlan risorsa.

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