기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

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

API Gateway API의 사용량 계획을 구성합니다. 사용량 계획에 대한 자세한 내용은 *API Gateway 개발자 안내서*의 [API 키를 이용한 사용량 계획의 생성 및 사용](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)을 참조하세요.

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

 AWS Serverless Application Model (AWS SAM) 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.

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

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

 `CreateUsagePlan`   <a name="sam-api-apiusageplan-createusageplan"></a>
이 사용량 계획의 구성 방법을 결정합니다. 유효한 값은 `PER_API`, `SHARED`, `NONE`입니다.  
`PER_API`는 이 API와 관련된 [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) 및 [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) 리소스를 생성합니다. 이러한 리소스는 `<api-logical-id>UsagePlan`, `<api-logical-id>ApiKey`, `<api-logical-id>UsagePlanKey`의 논리적 ID를 각각 가지고 있습니다.  
`SHARED`는 동일한 AWS SAM 템플릿에 도 있는 모든 API`CreateUsagePlan: SHARED`에서 공유되는 [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), 및 [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) 리소스를 생성합니다. 이러한 리소스는 `ServerlessUsagePlan`, `ServerlessApiKey`, `ServerlessUsagePlanKey`의 논리적 ID를 각각 가지고 있습니다. 이 옵션을 사용하는 경우 정의 충돌과 불확실한 상태를 방지하기 위해 하나의 API 리소스에만 이 사용량 계획의 추가 구성을 추가하는 것이 좋습니다.  
`NONE`는 이 API를 사용한 사용량 계획 생성 또는 연결을 비활성화합니다. 이는 [AWS SAM 템플릿의 글로벌 섹션](sam-specification-template-anatomy-globals.md)에서 `SHARED` 또는 `PER_API`가 지정된 경우에만 필요합니다.  
*유효한 값*: `PER_API`, `SHARED`, `NONE`   
*유형*: 문자열  
*필수 항목 여부:* 예  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

 `Description`   <a name="sam-api-apiusageplan-description"></a>
사용량 단계에 대한 설명입니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::UsagePlan` 리소스의 `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description)` 속성으로 직접 전달됩니다.

 `Quota`   <a name="sam-api-apiusageplan-quota"></a>
사용자가 지정된 간격 내에서 실행할 수 있는 요청 수를 구성합니다.  
*유형*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::UsagePlan` 리소스의 `[Quota](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)` 속성으로 직접 전달됩니다.

 `Tags`   <a name="sam-api-apiusageplan-tags"></a>
사용 계획과 연결할 임의 태그(키-값 페어)의 배열입니다.  
이 속성은 [CloudFormation 태그 유형](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)을 사용합니다.  
*유형*: 목록  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::UsagePlan` 리소스의 `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags)` 속성으로 직접 전달됩니다.

 `Throttle`   <a name="sam-api-apiusageplan-throttle"></a>
전체 요청 빈도(초당 평균 요청 수) 및 버스트 용량을 구성합니다.  
*유형*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::UsagePlan` 리소스의 `[Throttle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)` 속성으로 직접 전달됩니다.

 `UsagePlanName`   <a name="sam-api-apiusageplan-usageplanname"></a>
사용량 계획의 이름입니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::ApiGateway::UsagePlan` 리소스의 `[UsagePlanName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname)` 속성으로 직접 전달됩니다.

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

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

다음은 사용량 계획의 예시입니다.

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