Interface CfnUsagePlanProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUsagePlanProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:10.454Z")
@Stability(Stable)
public interface CfnUsagePlanProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnUsagePlan
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; CfnUsagePlanProps cfnUsagePlanProps = CfnUsagePlanProps.builder() .apiStages(List.of(ApiStageProperty.builder() .apiId("apiId") .stage("stage") .throttle(Map.of( "throttleKey", ThrottleSettingsProperty.builder() .burstLimit(123) .rateLimit(123) .build())) .build())) .description("description") .quota(QuotaSettingsProperty.builder() .limit(123) .offset(123) .period("period") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .throttle(ThrottleSettingsProperty.builder() .burstLimit(123) .rateLimit(123) .build()) .usagePlanName("usagePlanName") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUsagePlanProps
static final class
An implementation forCfnUsagePlanProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnUsagePlanProps.Builder
builder()
default Object
The associated API stages of a usage plan.default String
The description of a usage plan.default Object
getQuota()
The target maximum number of permitted requests per a given unit time interval.getTags()
The collection of tags.default Object
A map containing method level throttling information for API stage in a usage plan.default String
The name of a usage plan.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiStages
The associated API stages of a usage plan.- See Also:
-
getDescription
The description of a usage plan.- See Also:
-
getQuota
The target maximum number of permitted requests per a given unit time interval.- See Also:
-
getTags
The collection of tags.Each tag element is associated with a given resource.
- See Also:
-
getThrottle
A map containing method level throttling information for API stage in a usage plan.- See Also:
-
getUsagePlanName
The name of a usage plan.- See Also:
-
builder
- Returns:
- a
CfnUsagePlanProps.Builder
ofCfnUsagePlanProps
-