software.amazon.awscdk.services.apigateway

Interface CfnUsagePlan.ApiStageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsagePlan.ApiStageProperty.Jsii$Proxy

Enclosing class:

CfnUsagePlan

@Stability(value=Stable)
public static interface CfnUsagePlan.ApiStageProperty
extends software.amazon.jsii.JsiiSerializable

`ApiStage` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies which stages and APIs to associate with a usage plan.

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.*;
 ApiStageProperty apiStageProperty = ApiStageProperty.builder()
         .apiId("apiId")
         .stage("stage")
         .throttle(Map.of(
                 "throttleKey", ThrottleSettingsProperty.builder()
                         .burstLimit(123)
                         .rateLimit(123)
                         .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnUsagePlan.ApiStageProperty.Builder	builder()
default String	getApiId() The ID of an API that is in the specified `Stage` property that you want to associate with the usage plan.
default String	getStage() The name of the stage to associate with the usage plan.
default Object	getThrottle() Map containing method-level throttling information for an API stage in a usage plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiId

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

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

getStage

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

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

getThrottle

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

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.

builder

@Stability(value=Stable)
static CfnUsagePlan.ApiStageProperty.Builder builder()

Returns:

a CfnUsagePlan.ApiStageProperty.Builder of CfnUsagePlan.ApiStageProperty