ApiUsagePlan

API Gateway API의 사용량 계획을 구성합니다. 사용량 계획에 대한 자세한 내용은 API Gateway 개발자 안내서의 API 키를 이용한 사용량 계획의 생성 및 사용을 참조하세요.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

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

속성

CreateUsagePlan

이 사용량 계획의 구성 방법을 결정합니다. 유효한 값은 PER_API, SHARED, NONE입니다.

PER_API는 이 API와 관련된 AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey 및 AWS::ApiGateway::UsagePlanKey 리소스를 생성합니다. 이러한 리소스는 <api-logical-id>UsagePlan, <api-logical-id>ApiKey, <api-logical-id>UsagePlanKey의 논리적 ID를 각각 가지고 있습니다.

SHARED동일한 AWS SAM 템플릿에 있는 모든 CreateUsagePlan: SHARED API에서 공유되는 AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey, 및 AWS::ApiGateway::UsagePlanKey리소스를 생성합니다. 이러한 리소스는 ServerlessUsagePlan, ServerlessApiKey, ServerlessUsagePlanKey의 논리적 ID를 각각 가지고 있습니다. 이 옵션을 사용하는 경우 정의 충돌과 불확실한 상태를 방지하기 위해 하나의 API 리소스에만 이 사용량 계획의 추가 구성을 추가하는 것이 좋습니다.

NONE는 이 API를 사용한 사용량 계획 생성 또는 연결을 비활성화합니다. 이는 AWS SAM 템플릿의 Globals 섹션에서 SHARED 또는 PER_API가 지정된 경우에만 필요합니다.

유효한 값: PER_API, SHARED, NONE

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

Description

사용량 단계에 대한 설명입니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGateway::UsagePlan 리소스의 Description 속성으로 직접 전달됩니다.

Quota

사용자가 지정된 간격 내에서 실행할 수 있는 요청 수를 구성합니다.

유형: QuotaSettings

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGateway::UsagePlan 리소스의 Quota 속성으로 직접 전달됩니다.

Tags

사용 계획과 연결할 임의 태그(키-값 페어)의 배열입니다.

이 속성은 CloudFormation 태그 유형을 사용합니다.

유형: 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGateway::UsagePlan 리소스의 Tags 속성으로 직접 전달됩니다.

Throttle

전체 요청 빈도(초당 평균 요청 수) 및 버스트 용량을 구성합니다.

유형: ThrottleSettings

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGateway::UsagePlan 리소스의 Throttle 속성으로 직접 전달됩니다.

UsagePlanName

사용량 계획의 이름입니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGateway::UsagePlan 리소스의 UsagePlanName 속성에 직접 전달됩니다.

예

UsagePlan

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

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