Package software.amazon.awscdk.services.apigateway

Interface UsagePlanPerApiStage

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UsagePlanPerApiStage.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.694Z")
@Stability(Stable)
public interface UsagePlanPerApiStage
extends software.amazon.jsii.JsiiSerializable

Represents the API stages that a usage plan applies to.

Example:

 UsagePlan plan;
 RestApi api;
 Method echoMethod;
 plan.addApiStage(UsagePlanPerApiStage.builder()
         .stage(api.getDeploymentStage())
         .throttle(List.of(ThrottlingPerMethod.builder()
                 .method(echoMethod)
                 .throttle(ThrottleSettings.builder()
                         .rateLimit(10)
                         .burstLimit(2)
                         .build())
                 .build()))
         .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 IRestApi	getApi()	Default: none
default Stage	getStage()	[disable-awslint:ref-via-interface].
default List<ThrottlingPerMethod>	getThrottle()	Default: none

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

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

Default: none

getStage

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

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

Default: none

getThrottle

@Stability(Stable)
@Nullable
default List<ThrottlingPerMethod> getThrottle()

Default: none

builder

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

Returns:

a UsagePlanPerApiStage.Builder of UsagePlanPerApiStage