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(Stable)
public static final class CfnUsagePlanProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUsagePlanProps>
A builder for
CfnUsagePlanProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnUsagePlanProps.getApiStages()
apiStages
(IResolvable apiStages) Sets the value ofCfnUsagePlanProps.getApiStages()
build()
Builds the configured instance.description
(String description) Sets the value ofCfnUsagePlanProps.getDescription()
quota
(IResolvable quota) Sets the value ofCfnUsagePlanProps.getQuota()
Sets the value ofCfnUsagePlanProps.getQuota()
Sets the value ofCfnUsagePlanProps.getTags()
throttle
(IResolvable throttle) Sets the value ofCfnUsagePlanProps.getThrottle()
Sets the value ofCfnUsagePlanProps.getThrottle()
usagePlanName
(String usagePlanName) Sets the value ofCfnUsagePlanProps.getUsagePlanName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiStages
Sets the value ofCfnUsagePlanProps.getApiStages()
- Parameters:
apiStages
- The associated API stages of a usage plan.- Returns:
this
-
apiStages
Sets the value ofCfnUsagePlanProps.getApiStages()
- Parameters:
apiStages
- The associated API stages of a usage plan.- Returns:
this
-
description
Sets the value ofCfnUsagePlanProps.getDescription()
- Parameters:
description
- The description of a usage plan.- Returns:
this
-
quota
Sets the value ofCfnUsagePlanProps.getQuota()
- Parameters:
quota
- The target maximum number of permitted requests per a given unit time interval.- Returns:
this
-
quota
Sets the value ofCfnUsagePlanProps.getQuota()
- Parameters:
quota
- The target maximum number of permitted requests per a given unit time interval.- Returns:
this
-
tags
Sets the value ofCfnUsagePlanProps.getTags()
- Parameters:
tags
- The collection of tags. Each tag element is associated with a given resource.- Returns:
this
-
throttle
Sets the value ofCfnUsagePlanProps.getThrottle()
- Parameters:
throttle
- A map containing method level throttling information for API stage in a usage plan.- Returns:
this
-
throttle
@Stability(Stable) public CfnUsagePlanProps.Builder throttle(CfnUsagePlan.ThrottleSettingsProperty throttle) Sets the value ofCfnUsagePlanProps.getThrottle()
- Parameters:
throttle
- A map containing method level throttling information for API stage in a usage plan.- Returns:
this
-
usagePlanName
Sets the value ofCfnUsagePlanProps.getUsagePlanName()
- Parameters:
usagePlanName
- The name of a usage plan.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUsagePlanProps>
- Returns:
- a new instance of
CfnUsagePlanProps
- Throws:
NullPointerException
- if any required attribute was not provided
-