AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::UsagePlan

AWS::ApiGateway::UsagePlan 资源为部署的 Amazon API Gateway (API 网关) API 指定使用计划。使用计划对独立客户端 API 密钥强制实施限流和配额限制。有关更多信息,请参阅 API 网关 开发人员指南 中的在 Amazon API Gateway 中创建和使用 API 使用计划

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::ApiGateway::UsagePlan", "Properties" : { "ApiStages" : [ ApiStage, ... ], "Description" : String, "Quota" : QuotaSettings, "Throttle" : ThrottleSettings, "UsagePlanName" : String } }

YAML

Type: "AWS::ApiGateway::UsagePlan" Properties: ApiStages: - ApiStage Description: String Quota: QuotaSettings Throttle: ThrottleSettings UsagePlanName: String

属性

ApiStages

要与此使用计划关联的 API 阶段。

Required: No

Type: Amazon API Gateway UsagePlan ApiStage 列表

更新要求无需中断

Description

此使用计划的用途。

Required: No

Type: String

更新要求无需中断

Quota

配置用户可在指定时间间隔内发出的请求的数量。

Required: No

Type: Amazon API Gateway UsagePlan QuotaSettings

更新要求无需中断

Throttle

配置整体请求速率(每秒平均请求数)和突发容量。

Required: No

Type: Amazon API Gateway UsagePlan ThrottleSettings

更新要求无需中断

UsagePlanName

此使用计划的名称。

Required: No

Type: String

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回使用计划 ID(如 MyUsagePlan)。

有关使用 Ref 功能的更多信息,请参阅参考

示例

以下示例将为 Prod API 阶段创建使用计划,该计划的配额为每月 5000 个请求,速率限制为每秒 100 个请求。

JSON

"usagePlan" : { "Type" : "AWS::ApiGateway::UsagePlan", "Properties" : { "ApiStages" : [ {"ApiId" : { "Ref" : "MyRestApi" }, "Stage" : { "Ref" : "Prod" }} ], "Description" : "Customer ABC's usage plan", "Quota" : { "Limit" : 5000, "Period" : "MONTH" }, "Throttle" : { "BurstLimit" : 200, "RateLimit" : 100 }, "UsagePlanName" : "Plan_ABC" } }

YAML

usagePlan: Type: AWS::ApiGateway::UsagePlan Properties: ApiStages: - ApiId: !Ref 'MyRestApi' Stage: !Ref 'Prod' Description: Customer ABC's usage plan Quota: Limit: 5000 Period: MONTH Throttle: BurstLimit: 200 RateLimit: 100 UsagePlanName: Plan_ABC

本页内容: