UsagePlanProps

class aws_cdk.aws_apigateway.UsagePlanProps(*, api_key=None, api_stages=None, description=None, name=None, quota=None, throttle=None)

Bases: object

__init__(*, api_key=None, api_stages=None, description=None, name=None, quota=None, throttle=None)
Parameters
  • api_key (Optional[IApiKey]) – ApiKey to be associated with the usage plan. Default: none

  • api_stages (Optional[List[UsagePlanPerApiStage]]) – API Stages to be associated which the usage plan. Default: none

  • description (Optional[str]) – Represents usage plan purpose. Default: none

  • name (Optional[str]) – Name for this usage plan. Default: none

  • quota (Optional[QuotaSettings]) – Number of requests clients can make in a given time period. Default: none

  • throttle (Optional[ThrottleSettings]) – Overall throttle settings for the API. Default: none

Attributes

api_key

ApiKey to be associated with the usage plan.

default :default: none

Return type

Optional[IApiKey]

api_stages

API Stages to be associated which the usage plan.

default :default: none

Return type

Optional[List[UsagePlanPerApiStage]]

description

Represents usage plan purpose.

default :default: none

Return type

Optional[str]

name

Name for this usage plan.

default :default: none

Return type

Optional[str]

quota

Number of requests clients can make in a given time period.

default :default: none

Return type

Optional[QuotaSettings]

throttle

Overall throttle settings for the API.

default :default: none

Return type

Optional[ThrottleSettings]