UsagePlanPerApiStage

class aws_cdk.aws_apigatewayv2.UsagePlanPerApiStage(*, api=None, stage=None)

Bases: object

Represents the API stages that a usage plan applies to.

Parameters:

• api (Optional[IWebSocketApi]) – The WebSocket API to associate with the usage plan. Default: none

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

ExampleMetadata:

infused

Example:

api = apigwv2.WebSocketApi(self, "my-api")
stage = apigwv2.WebSocketStage(self, "my-stage",
    web_socket_api=api,
    stage_name="dev"
)

usage_plan = apigwv2.UsagePlan(self, "my-usage-plan",
    usage_plan_name="Basic"
)

usage_plan.add_api_stage(
    api=api,
    stage=stage
)

Attributes

api

The WebSocket API to associate with the usage plan.

Default:

none

stage

ref-via-interface].

Default:

none

Type:

[disable-awslint