software.amazon.awscdk.services.apigateway

Class UsagePlan.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.UsagePlan.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UsagePlan>

Enclosing class:

UsagePlan

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

A fluent builder for UsagePlan.

Method Summary

Modifier and Type	Method and Description
UsagePlan.Builder	apiStages(List<? extends UsagePlanPerApiStage> apiStages) API Stages to be associated with the usage plan.
UsagePlan	build()
static UsagePlan.Builder	create(software.constructs.Construct scope, String id)
UsagePlan.Builder	description(String description) Represents usage plan purpose.
UsagePlan.Builder	name(String name) Name for this usage plan.
UsagePlan.Builder	quota(QuotaSettings quota) Number of requests clients can make in a given time period.
UsagePlan.Builder	throttle(ThrottleSettings throttle) Overall throttle settings for the API.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static UsagePlan.Builder create(software.constructs.Construct scope,
                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UsagePlan.Builder.

apiStages

@Stability(value=Stable)
public UsagePlan.Builder apiStages(List<? extends UsagePlanPerApiStage> apiStages)

API Stages to be associated with the usage plan.

Default: none

Parameters:

apiStages - API Stages to be associated with the usage plan. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public UsagePlan.Builder description(String description)

Represents usage plan purpose.

Default: none

Parameters:

description - Represents usage plan purpose. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public UsagePlan.Builder name(String name)

Name for this usage plan.

Default: none

Parameters:

name - Name for this usage plan. This parameter is required.

Returns:

this

quota

@Stability(value=Stable)
public UsagePlan.Builder quota(QuotaSettings quota)

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

Default: none

Parameters:

quota - Number of requests clients can make in a given time period. This parameter is required.

Returns:

this

throttle

@Stability(value=Stable)
public UsagePlan.Builder throttle(ThrottleSettings throttle)

Overall throttle settings for the API.

Default: none

Parameters:

throttle - Overall throttle settings for the API. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public UsagePlan build()

Specified by:

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