ApiUsagePlan

この使用量プランの設定方法を決定します。有効な値は、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

型: 文字列

必須: はい

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のプロパティはありません。

使用量プランの説明です。

型: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGateway::UsagePlanリソースの Descriptionプロパティに直接渡されます。

指定された間隔内にユーザーが実行できるリクエストの数を設定します。

タイプ: QuotaSettings

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGateway::UsagePlanリソースの Quotaプロパティに直接渡されます。

使用量プランに関連付ける任意のタグの配列 (キーバリューペア) です。

このプロパティは、CloudFormation のタグタイプを使用します。

タイプ: リスト

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGateway::UsagePlanリソースの Tagsプロパティに直接渡されます。

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

タイプ: ThrottleSettings

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGateway::UsagePlanリソースの Throttleプロパティに直接渡されます。

使用量プランの名前です。

型: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGateway::UsagePlanリソースの UsagePlanNameプロパティに直接渡されます。