UsagePlanProps¶
-
class
aws_cdk.aws_apigateway.
UsagePlanProps
(*, api_key=None, api_stages=None, description=None, name=None, quota=None, throttle=None)¶ Bases:
object
- Parameters
api_key (
Optional
[IApiKey
]) – ApiKey to be associated with the usage plan. Default: noneapi_stages (
Optional
[Sequence
[UsagePlanPerApiStage
]]) – API Stages to be associated with the usage plan. Default: nonedescription (
Optional
[str
]) – Represents usage plan purpose. Default: nonename (
Optional
[str
]) – Name for this usage plan. Default: nonequota (
Optional
[QuotaSettings
]) – Number of requests clients can make in a given time period. Default: nonethrottle (
Optional
[ThrottleSettings
]) – Overall throttle settings for the API. Default: none
Attributes
-
api_stages
¶ API Stages to be associated with the usage plan.
- Default
none
- Return type
Optional
[List
[UsagePlanPerApiStage
]]
-
description
¶ Represents usage plan purpose.
- Default
none
- Return type
Optional
[str
]
-
name
¶ Name for this usage plan.
- Default
none
- Return type
Optional
[str
]
-
quota
¶ Number of requests clients can make in a given time period.
- Default
none
- Return type
Optional
[QuotaSettings
]
-
throttle
¶ Overall throttle settings for the API.
- Default
none
- Return type
Optional
[ThrottleSettings
]