Package software.amazon.awscdk.services.apigatewayv2

Interface UsagePlanPerApiStage

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UsagePlanPerApiStage.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-09T10:20:10.555Z")
@Stability(Stable)
public interface UsagePlanPerApiStage
extends software.amazon.jsii.JsiiSerializable

Represents the API stages that a usage plan applies to.

Example:

 WebSocketApi api = new WebSocketApi(this, "my-api");
 WebSocketStage stage = WebSocketStage.Builder.create(this, "my-stage")
         .webSocketApi(api)
         .stageName("dev")
         .build();
 UsagePlan usagePlan = UsagePlan.Builder.create(this, "my-usage-plan")
         .usagePlanName("Basic")
         .build();
 usagePlan.addApiStage(UsagePlanPerApiStage.builder()
         .api(api)
         .stage(stage)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UsagePlanPerApiStage.Builder	A builder for UsagePlanPerApiStage
static final class	UsagePlanPerApiStage.Jsii$Proxy	An implementation for UsagePlanPerApiStage

Method Summary

Modifier and Type	Method	Description
static UsagePlanPerApiStage.Builder	builder()
default IWebSocketApi	getApi()	The WebSocket API to associate with the usage plan.
default IWebSocketStage	getStage()	[disable-awslint:ref-via-interface].

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

@Stability(Stable)
@Nullable
default IWebSocketApi getApi()

The WebSocket API to associate with the usage plan.

Default: none

getStage

@Stability(Stable)
@Nullable
default IWebSocketStage getStage()

[disable-awslint:ref-via-interface].

Default: none

builder

@Stability(Stable)
static UsagePlanPerApiStage.Builder builder()

Returns:

a UsagePlanPerApiStage.Builder of UsagePlanPerApiStage