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::ApiGateway::UsagePlan、同じ AWS SAM テンプレートCreateUsagePlan: SHAREDに も存在する API 間で共有される AWS::ApiGateway::ApiKey、、および AWS::ApiGateway::UsagePlanKeyリソースを作成します。これらのリソースには、それぞれ ServerlessUsagePlan、ServerlessApiKey、および ServerlessUsagePlanKey の論理 ID があります。このオプションを使用する場合は、競合する定義と不確実な状態を避けるために、この使用量プランの設定を 1 つの 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

全体的なリクエスト率 (1 秒あたりの平均リクエスト数) とバーストキャパシティを設定します。

タイプ： 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