ApiUsagePlan

确定如何配置此使用计划。有效值包括 PER_API、SHARED 和 NONE。

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

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

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

有效值：PER_API、SHARED 和 NONE

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM而且没有Amazon CloudFormation等效项。

使用计划的描述。

类型：字符串

必需：否

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

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

类型：QuotaSettings

必需：否

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

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

此属性使用CloudFormation 标签类型.

类型：List

必需：否

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

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

类型：ThrottleSettings

必需：否

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

使用计划的名称。

类型：字符串

必需：否

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