Package software.amazon.awscdk.services.apigateway

Class CfnUsagePlan.QuotaSettingsProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUsagePlan.QuotaSettingsProperty>

Enclosing interface:

CfnUsagePlan.QuotaSettingsProperty

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

A builder for CfnUsagePlan.QuotaSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUsagePlan.QuotaSettingsProperty	build()	Builds the configured instance.
CfnUsagePlan.QuotaSettingsProperty.Builder	limit(Number limit)	Sets the value of CfnUsagePlan.QuotaSettingsProperty.getLimit()
CfnUsagePlan.QuotaSettingsProperty.Builder	offset(Number offset)	Sets the value of CfnUsagePlan.QuotaSettingsProperty.getOffset()
CfnUsagePlan.QuotaSettingsProperty.Builder	period(String period)	Sets the value of CfnUsagePlan.QuotaSettingsProperty.getPeriod()

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

limit

@Stability(Stable)
public CfnUsagePlan.QuotaSettingsProperty.Builder limit(Number limit)

Sets the value of CfnUsagePlan.QuotaSettingsProperty.getLimit()

Parameters:

limit - The target maximum number of requests that can be made in a given time period.

Returns:

this

offset

@Stability(Stable)
public CfnUsagePlan.QuotaSettingsProperty.Builder offset(Number offset)

Sets the value of CfnUsagePlan.QuotaSettingsProperty.getOffset()

Parameters:

offset - The number of requests subtracted from the given limit in the initial time period.

Returns:

this

period

@Stability(Stable)
public CfnUsagePlan.QuotaSettingsProperty.Builder period(String period)

Sets the value of CfnUsagePlan.QuotaSettingsProperty.getPeriod()

Parameters:

period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Returns:

this

build

@Stability(Stable)
public CfnUsagePlan.QuotaSettingsProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUsagePlan.QuotaSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided