ApiUsagePlan - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ApiUsagePlan

为 API Gateway API 配置使用计划。有关使用计划的更多信息,请参阅创建和使用带 API 密钥的使用计划中的API Gateway 开发人员指南.

Syntax

要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。

Properties

CreateUsagePlan

确定如何配置此使用计划。有效值包括 PER_APISHAREDNONE

PER_API创建AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey, 和AWS::ApiGateway::UsagePlanKey特定于此 API 的资源。这些资源的逻辑 ID 为<api-logical-id>UsagePlan<api-logical-id>ApiKey, 和<api-logical-id>UsagePlanKey,分别。

SHARED创建AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey, 和AWS::ApiGateway::UsagePlanKey在任何同时具有的 API 之间共享的资源CreateUsagePlan: SHARED在相同的Amazon SAM模板。这些资源的逻辑 ID 为ServerlessUsagePlanServerlessApiKey, 和ServerlessUsagePlanKey,分别。如果您使用此选项,我们建议您仅在一个 API 资源上为此使用计划添加其他配置,以避免定义冲突和状态不确定。

NONE禁用使用计划与此 API 的创建或关联。只有在这种情况下才需要SHARED或者PER_API已在的 “全局变量” 部分Amazon SAM模板.

有效值PER_APISHAREDNONE

类型:String

必需:是

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

Description

使用计划的描述。

类型:String

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给Description的财产AWS::ApiGateway::UsagePlan资源。

Quota

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

类型QuotaSettings

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给Quota的财产AWS::ApiGateway::UsagePlan资源。

Tags

与使用计划关联的任意标签(键值对)的数组。

此属性使用CloudFormation 标签类型.

类型:List

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给Tags一个的财产AWS::ApiGateway::UsagePlan资源。

Throttle

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

类型ThrottleSettings

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给Throttle一个的财产AWS::ApiGateway::UsagePlan资源。

UsagePlanName

使用计划的名称。

类型:String

必需:否

Amazon CloudFormation兼容性:此属性将直接传递给UsagePlanName一个的财产AWS::ApiGateway::UsagePlan资源。

Examples

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