software.amazon.awscdk.services.apigateway

Interface CfnUsagePlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsagePlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.142Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUsagePlanProps.Builder A builder for CfnUsagePlanProps
static class	CfnUsagePlanProps.Jsii$Proxy An implementation for CfnUsagePlanProps

Method Summary

Modifier and Type	Method and Description
static CfnUsagePlanProps.Builder	builder()
default Object	getApiStages() The API stages to associate with this usage plan.
default String	getDescription() A description of the usage plan.
default Object	getQuota() Configures the number of requests that users can make within a given interval.
default List<CfnTag>	getTags() An array of arbitrary tags (key-value pairs) to associate with the usage plan.
default Object	getThrottle() Configures the overall request rate (average requests per second) and burst capacity.
default String	getUsagePlanName() A name for the usage plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiStages

@Stability(value=Stable)
 @Nullable
default Object getApiStages()

The API stages to associate with this usage plan.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the usage plan.

getQuota

@Stability(value=Stable)
 @Nullable
default Object getQuota()

Configures the number of requests that users can make within a given interval.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of arbitrary tags (key-value pairs) to associate with the usage plan.

getThrottle

@Stability(value=Stable)
 @Nullable
default Object getThrottle()

Configures the overall request rate (average requests per second) and burst capacity.

getUsagePlanName

@Stability(value=Stable)
 @Nullable
default String getUsagePlanName()

A name for the usage plan.

builder

@Stability(value=Stable)
static CfnUsagePlanProps.Builder builder()

Returns:

a CfnUsagePlanProps.Builder of CfnUsagePlanProps