Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnUsagePlanPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnUsagePlanPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUsagePlanPropsMixin>

Enclosing class:

CfnUsagePlanPropsMixin

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

A fluent builder for CfnUsagePlanPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUsagePlanPropsMixin.Builder	apiStages(List<? extends Object> apiStages)	The associated API stages of a usage plan.
CfnUsagePlanPropsMixin.Builder	apiStages(IResolvable apiStages)	The associated API stages of a usage plan.
CfnUsagePlanPropsMixin	build()
static CfnUsagePlanPropsMixin.Builder	create()
static CfnUsagePlanPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUsagePlanPropsMixin.Builder	description(String description)	The description of a usage plan.
CfnUsagePlanPropsMixin.Builder	quota(CfnUsagePlanPropsMixin.QuotaSettingsProperty quota)	The target maximum number of permitted requests per a given unit time interval.
CfnUsagePlanPropsMixin.Builder	quota(IResolvable quota)	The target maximum number of permitted requests per a given unit time interval.
CfnUsagePlanPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The collection of tags.
CfnUsagePlanPropsMixin.Builder	throttle(CfnUsagePlanPropsMixin.ThrottleSettingsProperty throttle)	A map containing method level throttling information for API stage in a usage plan.
CfnUsagePlanPropsMixin.Builder	throttle(IResolvable throttle)	A map containing method level throttling information for API stage in a usage plan.
CfnUsagePlanPropsMixin.Builder	usagePlanName(String usagePlanName)	The name of a usage plan.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnUsagePlanPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUsagePlanPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUsagePlanPropsMixin.Builder create()

Returns:

a new instance of CfnUsagePlanPropsMixin.Builder.

apiStages

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder apiStages(IResolvable apiStages)

The associated API stages of a usage plan.

Parameters:

apiStages - The associated API stages of a usage plan. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages

apiStages

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder apiStages(List<? extends Object> apiStages)

The associated API stages of a usage plan.

Parameters:

apiStages - The associated API stages of a usage plan. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages

description

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

The description of a usage plan.

Parameters:

description - The description of a usage plan. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description

quota

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder quota(IResolvable quota)

The target maximum number of permitted requests per a given unit time interval.

Parameters:

quota - The target maximum number of permitted requests per a given unit time interval. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota

quota

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder quota(CfnUsagePlanPropsMixin.QuotaSettingsProperty quota)

The target maximum number of permitted requests per a given unit time interval.

Parameters:

quota - The target maximum number of permitted requests per a given unit time interval. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota

tags

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder tags(List<? extends CfnTag> tags)

The collection of tags.

Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags

throttle

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder throttle(IResolvable throttle)

A map containing method level throttling information for API stage in a usage plan.

Parameters:

throttle - A map containing method level throttling information for API stage in a usage plan. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle

throttle

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder throttle(CfnUsagePlanPropsMixin.ThrottleSettingsProperty throttle)

A map containing method level throttling information for API stage in a usage plan.

Parameters:

throttle - A map containing method level throttling information for API stage in a usage plan. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle

usagePlanName

@Stability(Stable)
public CfnUsagePlanPropsMixin.Builder usagePlanName(String usagePlanName)

The name of a usage plan.

Parameters:

usagePlanName - The name of a usage plan. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname

build

@Stability(Stable)
public CfnUsagePlanPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnUsagePlanPropsMixin.