Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# ApiUsagePlan
<a name="sam-property-api-apiusageplan"></a>

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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) nella *Guida per sviluppatori di API Gateway*.

## Sintassi
<a name="sam-property-api-apiusageplan-syntax"></a>

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

### YAML
<a name="sam-property-api-apiusageplan-syntax.yaml"></a>

```
  [CreateUsagePlan](#sam-api-apiusageplan-createusageplan): String
  [Description](#sam-api-apiusageplan-description): String
  [Quota](#sam-api-apiusageplan-quota): [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)
  [Tags](#sam-api-apiusageplan-tags): List
  [Throttle](#sam-api-apiusageplan-throttle): [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)
  [UsagePlanName](#sam-api-apiusageplan-usageplanname): String
```

## Properties
<a name="sam-property-api-apiusageplan-properties"></a>

 `CreateUsagePlan`   <a name="sam-api-apiusageplan-createusageplan"></a>
Determina come è configurato questo piano di utilizzo. I valori validi sono `PER_API`, `SHARED` e `NONE`.  
`PER_API`crea [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html)e [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html)risorse specifiche per questa API. Queste risorse hanno la logica IDs di `<api-logical-id>UsagePlan``<api-logical-id>ApiKey`, e`<api-logical-id>UsagePlanKey`, rispettivamente.  
`SHARED`crea [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html)e [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html)risorse condivise tra qualsiasi API che include `CreateUsagePlan: SHARED` anche lo stesso AWS SAM modello. [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) Queste risorse hanno la logica IDs di `ServerlessUsagePlan``ServerlessApiKey`, e`ServerlessUsagePlanKey`, 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 contrastanti e uno stato incerto.  
`NONE`disabilita 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](sam-specification-template-anatomy-globals.md)  
*Valori validi*: `PER_API`, `SHARED` e `NONE`  
▬*Tipo:* stringa  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: Questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

 `Description`   <a name="sam-api-apiusageplan-description"></a>
Una descrizione del piano di utilizzo.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description)` proprietà di una `AWS::ApiGateway::UsagePlan` risorsa.

 `Quota`   <a name="sam-api-apiusageplan-quota"></a>
Consente di configurare il numero di richieste che possono essere eseguite dagli utenti in un determinato intervallo.  
*Tipo:* [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[Quota](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)` proprietà di una `AWS::ApiGateway::UsagePlan` risorsa.

 `Tags`   <a name="sam-api-apiusageplan-tags"></a>
Un array di tag arbitrari (coppie chiave-valore) da associare al piano di utilizzo.  
Questa proprietà utilizza il [tipo di CloudFormation tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
Tipo: elenco  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags)` proprietà di una `AWS::ApiGateway::UsagePlan` risorsa.

 `Throttle`   <a name="sam-api-apiusageplan-throttle"></a>
Consente di configurare il tasso di richiesta complessivo (richieste medie al secondo) e la capacità di ottimizzazione.  
*Tipo:* [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[Throttle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)` proprietà di una `AWS::ApiGateway::UsagePlan` risorsa.

 `UsagePlanName`   <a name="sam-api-apiusageplan-usageplanname"></a>
Un nome per il piano di utilizzo.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[UsagePlanName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname)` proprietà di una `AWS::ApiGateway::UsagePlan` risorsa.

## Esempi
<a name="sam-property-api-apiusageplan--examples"></a>

### UsagePlan
<a name="sam-property-api-apiusageplan--examples--usageplan"></a>

Di seguito è riportato un esempio di piano di utilizzo.

#### YAML
<a name="sam-property-api-apiusageplan--examples--usageplan--yaml"></a>

```
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
```