software.amazon.awscdk.services.apigateway

Class CfnUsagePlan.ApiStageProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnUsagePlan.ApiStageProperty

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

A builder for CfnUsagePlan.ApiStageProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnUsagePlan.ApiStageProperty.Builder	apiId(String apiId) Sets the value of CfnUsagePlan.ApiStageProperty.getApiId()
CfnUsagePlan.ApiStageProperty	build() Builds the configured instance.
CfnUsagePlan.ApiStageProperty.Builder	stage(String stage) Sets the value of CfnUsagePlan.ApiStageProperty.getStage()
CfnUsagePlan.ApiStageProperty.Builder	throttle(IResolvable throttle) Sets the value of CfnUsagePlan.ApiStageProperty.getThrottle()
CfnUsagePlan.ApiStageProperty.Builder	throttle(Map<String,? extends Object> throttle) Sets the value of CfnUsagePlan.ApiStageProperty.getThrottle()

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

apiId

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

Sets the value of CfnUsagePlan.ApiStageProperty.getApiId()

Parameters:

apiId - The ID of an API that is in the specified `Stage` property that you want to associate with the usage plan.

Returns:

this

stage

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

Sets the value of CfnUsagePlan.ApiStageProperty.getStage()

Parameters:

stage - The name of the stage to associate with the usage plan.

Returns:

this

throttle

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

Sets the value of CfnUsagePlan.ApiStageProperty.getThrottle()

Parameters:

throttle - Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, "/pets/GET".

Duplicates are not allowed.

Returns:

this

throttle

@Stability(value=Stable)
public CfnUsagePlan.ApiStageProperty.Builder throttle(Map<String,? extends Object> throttle)

Sets the value of CfnUsagePlan.ApiStageProperty.getThrottle()

Parameters:

throttle - Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, "/pets/GET".

Duplicates are not allowed.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUsagePlan.ApiStageProperty

Throws:

NullPointerException - if any required attribute was not provided