software.amazon.awscdk.services.apigateway

Class CfnUsagePlan.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnUsagePlan.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUsagePlan>

Enclosing class:

CfnUsagePlan

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

A fluent builder for CfnUsagePlan.

Method Summary

Modifier and Type	Method and Description
CfnUsagePlan.Builder	apiStages(IResolvable apiStages) The API stages to associate with this usage plan.
CfnUsagePlan.Builder	apiStages(List<? extends Object> apiStages) The API stages to associate with this usage plan.
CfnUsagePlan	build()
static CfnUsagePlan.Builder	create(software.constructs.Construct scope, String id)
CfnUsagePlan.Builder	description(String description) A description of the usage plan.
CfnUsagePlan.Builder	quota(CfnUsagePlan.QuotaSettingsProperty quota) Configures the number of requests that users can make within a given interval.
CfnUsagePlan.Builder	quota(IResolvable quota) Configures the number of requests that users can make within a given interval.
CfnUsagePlan.Builder	tags(List<? extends CfnTag> tags) An array of arbitrary tags (key-value pairs) to associate with the usage plan.
CfnUsagePlan.Builder	throttle(CfnUsagePlan.ThrottleSettingsProperty throttle) Configures the overall request rate (average requests per second) and burst capacity.
CfnUsagePlan.Builder	throttle(IResolvable throttle) Configures the overall request rate (average requests per second) and burst capacity.
CfnUsagePlan.Builder	usagePlanName(String usagePlanName) A name for the usage plan.

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 CfnUsagePlan.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnUsagePlan.ApiStageProperty.Builder.

apiStages

@Stability(value=Stable)
public CfnUsagePlan.Builder apiStages(IResolvable apiStages)

The API stages to associate with this usage plan.

Parameters:

apiStages - The API stages to associate with this usage plan. This parameter is required.

Returns:

this

apiStages

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

The API stages to associate with this usage plan.

Parameters:

apiStages - The API stages to associate with this usage plan. This parameter is required.

Returns:

this

description

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

A description of the usage plan.

Parameters:

description - A description of the usage plan. This parameter is required.

Returns:

this

quota

@Stability(value=Stable)
public CfnUsagePlan.Builder quota(CfnUsagePlan.QuotaSettingsProperty quota)

Configures the number of requests that users can make within a given interval.

Parameters:

quota - Configures the number of requests that users can make within a given interval. This parameter is required.

Returns:

this

quota

@Stability(value=Stable)
public CfnUsagePlan.Builder quota(IResolvable quota)

Configures the number of requests that users can make within a given interval.

Parameters:

quota - Configures the number of requests that users can make within a given interval. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnUsagePlan.Builder tags(List<? extends CfnTag> tags)

An array of arbitrary tags (key-value pairs) to associate with the usage plan.

Parameters:

tags - An array of arbitrary tags (key-value pairs) to associate with the usage plan. This parameter is required.

Returns:

this

throttle

@Stability(value=Stable)
public CfnUsagePlan.Builder throttle(CfnUsagePlan.ThrottleSettingsProperty throttle)

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

Parameters:

throttle - Configures the overall request rate (average requests per second) and burst capacity. This parameter is required.

Returns:

this

throttle

@Stability(value=Stable)
public CfnUsagePlan.Builder throttle(IResolvable throttle)

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

Parameters:

throttle - Configures the overall request rate (average requests per second) and burst capacity. This parameter is required.

Returns:

this

usagePlanName

@Stability(value=Stable)
public CfnUsagePlan.Builder usagePlanName(String usagePlanName)

A name for the usage plan.

Parameters:

usagePlanName - A name for the usage plan. This parameter is required.

Returns:

this

build

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

Specified by:

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