翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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
の論理 ID があります。<api-logical-id>
UsagePlanKeySHARED
は、同じ AWS SAM テンプレートにCreateUsagePlan: SHARED
があるすべてのAPIで共有される AWS::ApiGateway::UsagePlan、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
プロパティに直接渡されます。 -
使用量プランに関連付ける任意のタグの配列 (キーバリューペア) です。
このプロパティは、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