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) `AWS::ApiGateway::UsagePlan.ApiStages`.
CfnUsagePlan.Builder	apiStages(List<? extends Object> apiStages) `AWS::ApiGateway::UsagePlan.ApiStages`.
CfnUsagePlan	build()
static CfnUsagePlan.Builder	create(software.constructs.Construct scope, String id)
CfnUsagePlan.Builder	description(String description) `AWS::ApiGateway::UsagePlan.Description`.
CfnUsagePlan.Builder	quota(CfnUsagePlan.QuotaSettingsProperty quota) `AWS::ApiGateway::UsagePlan.Quota`.
CfnUsagePlan.Builder	quota(IResolvable quota) `AWS::ApiGateway::UsagePlan.Quota`.
CfnUsagePlan.Builder	tags(List<? extends CfnTag> tags) `AWS::ApiGateway::UsagePlan.Tags`.
CfnUsagePlan.Builder	throttle(CfnUsagePlan.ThrottleSettingsProperty throttle) `AWS::ApiGateway::UsagePlan.Throttle`.
CfnUsagePlan.Builder	throttle(IResolvable throttle) `AWS::ApiGateway::UsagePlan.Throttle`.
CfnUsagePlan.Builder	usagePlanName(String usagePlanName) `AWS::ApiGateway::UsagePlan.UsagePlanName`.

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)

`AWS::ApiGateway::UsagePlan.ApiStages`.

Parameters:

apiStages - `AWS::ApiGateway::UsagePlan.ApiStages`. This parameter is required.

Returns:

this

apiStages

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

`AWS::ApiGateway::UsagePlan.ApiStages`.

Parameters:

apiStages - `AWS::ApiGateway::UsagePlan.ApiStages`. This parameter is required.

Returns:

this

description

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

`AWS::ApiGateway::UsagePlan.Description`.

Parameters:

description - `AWS::ApiGateway::UsagePlan.Description`. This parameter is required.

Returns:

this

quota

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

`AWS::ApiGateway::UsagePlan.Quota`.

Parameters:

quota - `AWS::ApiGateway::UsagePlan.Quota`. This parameter is required.

Returns:

this

quota

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

`AWS::ApiGateway::UsagePlan.Quota`.

Parameters:

quota - `AWS::ApiGateway::UsagePlan.Quota`. This parameter is required.

Returns:

this

tags

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

`AWS::ApiGateway::UsagePlan.Tags`.

Parameters:

tags - `AWS::ApiGateway::UsagePlan.Tags`. This parameter is required.

Returns:

this

throttle

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

`AWS::ApiGateway::UsagePlan.Throttle`.

Parameters:

throttle - `AWS::ApiGateway::UsagePlan.Throttle`. This parameter is required.

Returns:

this

throttle

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

`AWS::ApiGateway::UsagePlan.Throttle`.

Parameters:

throttle - `AWS::ApiGateway::UsagePlan.Throttle`. This parameter is required.

Returns:

this

usagePlanName

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

`AWS::ApiGateway::UsagePlan.UsagePlanName`.

Parameters:

usagePlanName - `AWS::ApiGateway::UsagePlan.UsagePlanName`. This parameter is required.

Returns:

this

build

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

Specified by:

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