Package software.amazon.awscdk.services.apigateway

Interface ThrottlingPerMethod

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ThrottlingPerMethod.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:20.753Z")
@Stability(Stable)
public interface ThrottlingPerMethod
extends software.amazon.jsii.JsiiSerializable

Represents per-method throttling for a resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 Method method;
 ThrottlingPerMethod throttlingPerMethod = ThrottlingPerMethod.builder()
         .method(method)
         .throttle(ThrottleSettings.builder()
                 .burstLimit(123)
                 .rateLimit(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ThrottlingPerMethod.Builder	builder()
Method	getMethod()	[disable-awslint:ref-via-interface] The method for which you specify the throttling settings.
ThrottleSettings	getThrottle()	Specifies the overall request rate (average requests per second) and burst capacity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@NotNull
Method getMethod()

[disable-awslint:ref-via-interface] The method for which you specify the throttling settings.

Default: none

getThrottle

@Stability(Stable)
@NotNull
ThrottleSettings getThrottle()

Specifies the overall request rate (average requests per second) and burst capacity.

Default: none

builder

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

Returns:

a ThrottlingPerMethod.Builder of ThrottlingPerMethod