ApiUsagePlan

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

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

SHARED创建 AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey 和 AWS::ApiGateway::UsagePlanKey在同一 AWS SAM 模板中也包含的任何 API 之间共享CreateUsagePlan: SHARED的资源。这些资源的逻辑 IDs 分别为ServerlessUsagePlanServerlessApiKeyServerlessUsagePlanKey、和。如果您使用此选项，我们建议您仅在一个 API 资源中为此使用计划添加其他配置，以避免定义冲突和状态不确定性。

NONE 禁止创建使用计划或将使用计划与此 API 关联。在 AWS SAM 模板的全局变量部分 中指定了 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属性。

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

类型：ThrottleSettings

必需：否

CloudFormation 兼容性：此属性直接传递给AWS::ApiGateway::UsagePlan资源的Throttle属性。

使用计划的名称。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给AWS::ApiGateway::UsagePlan资源的UsagePlanName属性。