Package 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(Stable)
public static interface CfnUsagePlan.ApiStageProperty
extends software.amazon.jsii.JsiiSerializable

API stage name of the associated API stage in 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUsagePlan.ApiStageProperty.Builder	builder()
default String	getApiId()	API Id of the associated API stage in a usage plan.
default String	getStage()	API stage name of the associated API stage in a usage plan.
default Object	getThrottle()	Map containing method level throttling information for API stage in a usage plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

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

API Id of the associated API stage in a usage plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid

getStage

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

API stage name of the associated API stage in a usage plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage

getThrottle

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

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

See Also:

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

builder

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

Returns:

a CfnUsagePlan.ApiStageProperty.Builder of CfnUsagePlan.ApiStageProperty