Package software.amazon.awscdk.services.apigateway

Class UsagePlanProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.UsagePlanProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UsagePlanProps>

Enclosing interface:

UsagePlanProps

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

A builder for UsagePlanProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UsagePlanProps.Builder	apiKey(IApiKey apiKey)	Deprecated. use `addApiKey()`
UsagePlanProps.Builder	apiStages(List<? extends UsagePlanPerApiStage> apiStages)	Sets the value of UsagePlanProps.getApiStages()
UsagePlanProps	build()	Builds the configured instance.
UsagePlanProps.Builder	description(String description)	Sets the value of UsagePlanProps.getDescription()
UsagePlanProps.Builder	name(String name)	Sets the value of UsagePlanProps.getName()
UsagePlanProps.Builder	quota(QuotaSettings quota)	Sets the value of UsagePlanProps.getQuota()
UsagePlanProps.Builder	throttle(ThrottleSettings throttle)	Sets the value of UsagePlanProps.getThrottle()

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

apiKey

@Stability(Deprecated)
@Deprecated
public UsagePlanProps.Builder apiKey(IApiKey apiKey)

Deprecated.

use `addApiKey()`

Sets the value of UsagePlanProps.getApiKey()

Parameters:

apiKey - ApiKey to be associated with the usage plan.

Returns:

this

apiStages

@Stability(Stable)
public UsagePlanProps.Builder apiStages(List<? extends UsagePlanPerApiStage> apiStages)

Sets the value of UsagePlanProps.getApiStages()

Parameters:

apiStages - API Stages to be associated with the usage plan.

Returns:

this

description

@Stability(Stable)
public UsagePlanProps.Builder description(String description)

Sets the value of UsagePlanProps.getDescription()

Parameters:

description - Represents usage plan purpose.

Returns:

this

name

@Stability(Stable)
public UsagePlanProps.Builder name(String name)

Sets the value of UsagePlanProps.getName()

Parameters:

name - Name for this usage plan.

Returns:

this

quota

@Stability(Stable)
public UsagePlanProps.Builder quota(QuotaSettings quota)

Sets the value of UsagePlanProps.getQuota()

Parameters:

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

Returns:

this

throttle

@Stability(Stable)
public UsagePlanProps.Builder throttle(ThrottleSettings throttle)

Sets the value of UsagePlanProps.getThrottle()

Parameters:

throttle - Overall throttle settings for the API.

Returns:

this

build

@Stability(Stable)
public UsagePlanProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UsagePlanProps

Throws:

NullPointerException - if any required attribute was not provided