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

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

ApiUsagePlan

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

语法

在你的 AWS 无服务器应用程序模型 (AWS SAM)模板,使用以下语法。

属性

CreateUsagePlan

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

PER_API 创造 ASTA::ApiGateway::Usage计划, ASTA::ApiGateway::ApiKey、和 ASTA::ApiGateway::UsageplanKey 此API特定的资源。这些资源的逻辑ID为 <api-logical-id>UsagePlan, <api-logical-id>ApiKey、和 <api-logical-id>UsagePlanKey

SHARED 创造 ASTA::ApiGateway::Usage计划, ASTA::ApiGateway::ApiKey、和 ASTA::ApiGateway::UsageplanKey 共享到任何API的资源, CreateUsagePlan: SHARED 相同 AWS SAM 模板。这些资源的逻辑ID为 ServerlessUsagePlan, ServerlessApiKey、和 ServerlessUsagePlanKey。如果您使用此选项,我们建议您仅在一个API资源上为此使用计划添加额外配置,以避免定义冲突和不确定状态。

NONE 禁用创建或使用计划或与此API关联。只有在下列情况下才有必要: SHAREDPER_API的Globals部分 AWS SAM 模板.

类型:字符串

必需: 是

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

Description

使用计划的描述。

类型:字符串

必需: 否

AWS CloudFormation 相容性: 此属性直接传递给 Description 特性 AWS::ApiGateway::UsagePlan 资源。

Quota

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

类型QuotaSettings

必需: 否

AWS CloudFormation 相容性: 此属性直接传递给 Quota 特性 AWS::ApiGateway::UsagePlan 资源。

Tags

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

该属性使用 CloudFormation标记类型.

类型:列表

必需: 否

AWS CloudFormation 相容性: 此属性直接传递给 Tags 特性 AWS::ApiGateway::UsagePlan 资源。

Throttle

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

类型ThrottleSettings

必需: 否

AWS CloudFormation 相容性: 此属性直接传递给 Throttle 特性 AWS::ApiGateway::UsagePlan 资源。

UsagePlanName

使用计划的名称。

类型:字符串

必需: 否

AWS CloudFormation 相容性: 此属性直接传递给 UsagePlanName 特性 AWS::ApiGateway::UsagePlan 资源。

示例

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