CfnUsagePlanProps¶
-
class
aws_cdk.aws_apigateway.
CfnUsagePlanProps
(*, api_stages=None, description=None, quota=None, tags=None, throttle=None, usage_plan_name=None)¶ Bases:
object
Properties for defining a
CfnUsagePlan
.- Parameters
api_stages (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ApiStageProperty
]],None
]) – The API stages to associate with this usage plan.description (
Optional
[str
]) – A description of the usage plan.quota (
Union
[IResolvable
,QuotaSettingsProperty
,None
]) – Configures the number of requests that users can make within a given interval.tags (
Optional
[Sequence
[CfnTag
]]) – An array of arbitrary tags (key-value pairs) to associate with the usage plan.throttle (
Union
[IResolvable
,ThrottleSettingsProperty
,None
]) – Configures the overall request rate (average requests per second) and burst capacity.usage_plan_name (
Optional
[str
]) – A name for the usage plan.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_apigateway as apigateway cfn_usage_plan_props = apigateway.CfnUsagePlanProps( api_stages=[apigateway.CfnUsagePlan.ApiStageProperty( api_id="apiId", stage="stage", throttle={ "throttle_key": apigateway.CfnUsagePlan.ThrottleSettingsProperty( burst_limit=123, rate_limit=123 ) } )], description="description", quota=apigateway.CfnUsagePlan.QuotaSettingsProperty( limit=123, offset=123, period="period" ), tags=[CfnTag( key="key", value="value" )], throttle=apigateway.CfnUsagePlan.ThrottleSettingsProperty( burst_limit=123, rate_limit=123 ), usage_plan_name="usagePlanName" )
Attributes
-
api_stages
¶ The API stages to associate with this usage plan.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,ApiStageProperty
]],None
]
-
description
¶ A description of the usage plan.
-
quota
¶ Configures the number of requests that users can make within a given interval.
An array of arbitrary tags (key-value pairs) to associate with the usage plan.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
throttle
¶ Configures the overall request rate (average requests per second) and burst capacity.
-
usage_plan_name
¶ A name for the usage plan.