software.amazon.awscdk.services.apigateway

Class CfnUsagePlanProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnUsagePlanProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUsagePlanProps>

Enclosing interface:

CfnUsagePlanProps

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

A builder for CfnUsagePlanProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnUsagePlanProps.Builder	apiStages(IResolvable apiStages) Sets the value of CfnUsagePlanProps.getApiStages()
CfnUsagePlanProps.Builder	apiStages(List<? extends Object> apiStages) Sets the value of CfnUsagePlanProps.getApiStages()
CfnUsagePlanProps	build() Builds the configured instance.
CfnUsagePlanProps.Builder	description(String description) Sets the value of CfnUsagePlanProps.getDescription()
CfnUsagePlanProps.Builder	quota(CfnUsagePlan.QuotaSettingsProperty quota) Sets the value of CfnUsagePlanProps.getQuota()
CfnUsagePlanProps.Builder	quota(IResolvable quota) Sets the value of CfnUsagePlanProps.getQuota()
CfnUsagePlanProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnUsagePlanProps.getTags()
CfnUsagePlanProps.Builder	throttle(CfnUsagePlan.ThrottleSettingsProperty throttle) Sets the value of CfnUsagePlanProps.getThrottle()
CfnUsagePlanProps.Builder	throttle(IResolvable throttle) Sets the value of CfnUsagePlanProps.getThrottle()
CfnUsagePlanProps.Builder	usagePlanName(String usagePlanName) Sets the value of CfnUsagePlanProps.getUsagePlanName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

apiStages

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

Sets the value of CfnUsagePlanProps.getApiStages()

Parameters:

apiStages - The API stages to associate with this usage plan.

Returns:

this

apiStages

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

Sets the value of CfnUsagePlanProps.getApiStages()

Parameters:

apiStages - The API stages to associate with this usage plan.

Returns:

this

description

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

Sets the value of CfnUsagePlanProps.getDescription()

Parameters:

description - A description of the usage plan.

Returns:

this

quota

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

Sets the value of CfnUsagePlanProps.getQuota()

Parameters:

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

Returns:

this

quota

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

Sets the value of CfnUsagePlanProps.getQuota()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnUsagePlanProps.getTags()

Parameters:

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

Returns:

this

throttle

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

Sets the value of CfnUsagePlanProps.getThrottle()

Parameters:

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

Returns:

this

throttle

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

Sets the value of CfnUsagePlanProps.getThrottle()

Parameters:

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

Returns:

this

usagePlanName

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

Sets the value of CfnUsagePlanProps.getUsagePlanName()

Parameters:

usagePlanName - A name for the usage plan.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUsagePlanProps

Throws:

NullPointerException - if any required attribute was not provided