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建立AWS::ApiGateway::UsagePlan此 API 專屬的AWS::ApiGateway::ApiKey、和AWS::ApiGateway::UsagePlanKey資源。這些資源分別具有<api-logical-id>UsagePlan<api-logical-id>ApiKey<api-logical-id>UsagePlanKey、和的邏輯 ID。

SHARED建立AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey、和AWS::ApiGateway::UsagePlanKey資源，這些 API 在同一 AWS SAM 範本中也包含CreateUsagePlan: SHARED的任何 API 共用。這些資源分別具有ServerlessUsagePlanServerlessApiKeyServerlessUsagePlanKey、和的邏輯 ID。如果您使用此選項，建議您僅在一個 API 資源上新增此使用方案的其他設定，以避免發生衝突的定義和不確定的狀態。

NONE停用使用計劃與此 API 的建立或關聯。只有在中指定SHARED或PER_API時，才需要此操作模板的全局部分 AWS SAM。

有效值：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