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
,Dict
[str
,Any
]]],None
]) – The associated API stages of a usage plan.description (
Optional
[str
]) – The description of a usage plan.quota (
Union
[IResolvable
,QuotaSettingsProperty
,Dict
[str
,Any
],None
]) – The target maximum number of permitted requests per a given unit time interval.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The collection of tags. Each tag element is associated with a given resource.throttle (
Union
[IResolvable
,ThrottleSettingsProperty
,Dict
[str
,Any
],None
]) – A map containing method level throttling information for API stage in a usage plan.usage_plan_name (
Optional
[str
]) – The name of a 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 associated API stages of a usage plan.
- description
The description of a usage plan.
- quota
The target maximum number of permitted requests per a given unit time interval.
- tags
The collection of tags.
Each tag element is associated with a given resource.
- throttle
A map containing method level throttling information for API stage in a usage plan.
- usage_plan_name
The name of a usage plan.