Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Mengonfigurasi rencana penggunaan untuk API dari API Gateway. Untuk informasi selengkapnya tentang rencana penggunaan, lihat [Buat dan Gunakan Rencana Penggunaan dengan Kunci API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) di *Panduan Developer API Gateway*.

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

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

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

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

 `CreateUsagePlan`   <a name="sam-api-apiusageplan-createusageplan"></a>
Menentukan cara rencana penggunaan ini dikonfigurasi. Nilai yang valid adalah `PER_API`, `SHARED`, dan `NONE`.  
`PER_API`membuat [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), [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), dan [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)sumber daya yang khusus untuk API ini. Sumber daya ini memiliki logika IDs `<api-logical-id>UsagePlan`,`<api-logical-id>ApiKey`, dan`<api-logical-id>UsagePlanKey`, masing-masing.  
`SHARED`membuat [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), [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), dan [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)sumber daya yang dibagikan di seluruh API apa pun yang juga ada `CreateUsagePlan: SHARED` di AWS SAM template yang sama. Sumber daya ini memiliki logika IDs `ServerlessUsagePlan`,`ServerlessApiKey`, dan`ServerlessUsagePlanKey`, masing-masing. 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 template AWS SAM](sam-specification-template-anatomy-globals.md).  
*Nilai yang valid adalah *: `PER_API`, `SHARED`, and `NONE`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Description`   <a name="sam-api-apiusageplan-description"></a>
Deskripsi rencana penggunaan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `Quota`   <a name="sam-api-apiusageplan-quota"></a>
Mengonfigurasi jumlah permintaan yang dapat dibuat pengguna dalam interval tertentu.  
*Jenis*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Quota](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `Tags`   <a name="sam-api-apiusageplan-tags"></a>
Susunan tanda bebas (pasangan nilai kunci) untuk mengaitkan dengan rencana penggunaan.  
Properti ini menggunakan [Jenis CloudFormation Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `Throttle`   <a name="sam-api-apiusageplan-throttle"></a>
Mengonfigurasi laju permintaan keseluruhan (permintaan rata-rata per detik) dan kapasitas lonjakan.  
*Jenis*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Throttle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

 `UsagePlanName`   <a name="sam-api-apiusageplan-usageplanname"></a>
Sebuah nama untuk rencana penggunaan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[UsagePlanName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname)` properti `AWS::ApiGateway::UsagePlan` sumber daya.

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

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

Berikut ini adalah contoh rencana penggunaan.

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