Package software.amazon.awscdk.services.apigatewayv2

Interface UsagePlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UsagePlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:05.003Z")
@Stability(Stable)
public interface UsagePlanProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining an API Gateway Usage Plan for WebSocket APIs.

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	UsagePlanProps.Builder	A builder for UsagePlanProps
static final class	UsagePlanProps.Jsii$Proxy	An implementation for UsagePlanProps

Method Summary

Modifier and Type	Method	Description
static UsagePlanProps.Builder	builder()
default List<UsagePlanPerApiStage>	getApiStages()	API Stages to be associated with the usage plan.
default String	getDescription()	Represents usage plan purpose.
default QuotaSettings	getQuota()	Number of requests clients can make in a given time period.
default ThrottleSettings	getThrottle()	Overall throttle settings for the API.
default String	getUsagePlanName()	Name for this usage plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiStages

@Stability(Stable)
@Nullable
default List<UsagePlanPerApiStage> getApiStages()

API Stages to be associated with the usage plan.

Default: none

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Represents usage plan purpose.

Default: none

getQuota

@Stability(Stable)
@Nullable
default QuotaSettings getQuota()

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

Default: none

getThrottle

@Stability(Stable)
@Nullable
default ThrottleSettings getThrottle()

Overall throttle settings for the API.

Default: none

getUsagePlanName

@Stability(Stable)
@Nullable
default String getUsagePlanName()

Name for this usage plan.

Default: none

builder

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

Returns:

a UsagePlanProps.Builder of UsagePlanProps