UsagePlan

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

Bases: aws_cdk.core.Resource

__init__(scope, id, *, api_key=None, api_stages=None, description=None, name=None, quota=None, throttle=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • 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

Return type

None

Methods

add_api_key(api_key)

Adds an ApiKey.

Parameters

api_key (IApiKey) –

Return type

None

add_api_stage(*, api=None, stage=None, throttle=None)

Adds an apiStage.

Parameters
  • api_stage

  • api (Optional[IRestApi]) – Default: none

  • stage (Optional[Stage]) – [disable-awslint:ref-via-interface]. Default: none

  • throttle (Optional[List[ThrottlingPerMethod]]) – Default: none

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

usage_plan_id

attribute: :attribute:: true

Return type

str

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool