Package software.amazon.awscdk.services.apigateway

Class ThrottleSettings.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.ThrottleSettings.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ThrottleSettings>

Enclosing interface:

ThrottleSettings

@Stability(Stable)
public static final class ThrottleSettings.Builder
extends Object
implements software.amazon.jsii.Builder<ThrottleSettings>

A builder for ThrottleSettings

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ThrottleSettings	build()	Builds the configured instance.
ThrottleSettings.Builder	burstLimit(Number burstLimit)	Sets the value of ThrottleSettings.getBurstLimit()
ThrottleSettings.Builder	rateLimit(Number rateLimit)	Sets the value of ThrottleSettings.getRateLimit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

burstLimit

@Stability(Stable)
public ThrottleSettings.Builder burstLimit(Number burstLimit)

Sets the value of ThrottleSettings.getBurstLimit()

Parameters:

burstLimit - The maximum API request rate limit over a time ranging from one to a few seconds.

Returns:

this

rateLimit

@Stability(Stable)
public ThrottleSettings.Builder rateLimit(Number rateLimit)

Sets the value of ThrottleSettings.getRateLimit()

Parameters:

rateLimit - The API request steady-state rate limit (average requests per second over an extended period of time).

Returns:

this

build

@Stability(Stable)
public ThrottleSettings build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ThrottleSettings>

Returns:

a new instance of ThrottleSettings

Throws:

NullPointerException - if any required attribute was not provided