Package 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.104.0 (build e79254c)",
           date="2024-12-17T21:37:25.470Z")
@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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUsagePlanProps.Builder	builder()
default Object	getApiStages()	The associated API stages of a usage plan.
default String	getDescription()	The description of a usage plan.
default Object	getQuota()	The target maximum number of permitted requests per a given unit time interval.
default List<CfnTag>	getTags()	The collection of tags.
default Object	getThrottle()	A map containing method level throttling information for API stage in a usage plan.
default String	getUsagePlanName()	The name of a usage plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiStages

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

The associated API stages of a usage plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages

getDescription

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

The description of a usage plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description

getQuota

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

The target maximum number of permitted requests per a given unit time interval.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota

getTags

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

The collection of tags.

Each tag element is associated with a given resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags

getThrottle

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

A map containing method level throttling information for API stage in a usage plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle

getUsagePlanName

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

The name of a usage plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname

builder

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

Returns:

a CfnUsagePlanProps.Builder of CfnUsagePlanProps