aws-cdk-lib.aws_apigateway.UsagePlanPerApiStage

interface UsagePlanPerApiStage

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.UsagePlanPerApiStage
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#UsagePlanPerApiStage
Javasoftware.amazon.awscdk.services.apigateway.UsagePlanPerApiStage
Pythonaws_cdk.aws_apigateway.UsagePlanPerApiStage
TypeScript (source)aws-cdk-lib » aws_apigateway » UsagePlanPerApiStage

Represents the API stages that a usage plan applies to.

Example

declare const plan: apigateway.UsagePlan;
declare const api: apigateway.RestApi;
declare const echoMethod: apigateway.Method;

plan.addApiStage({
  stage: api.deploymentStage,
  throttle: [
    {
      method: echoMethod,
      throttle: {
        rateLimit: 10,
        burstLimit: 2
      }
    }
  ]
});

Properties

NameTypeDescription
api?IRestApi
stage?Stage[disable-awslint:ref-via-interface].
throttle?ThrottlingPerMethod[]

api?

Type: IRestApi (optional, default: none)


stage?

Type: Stage (optional, default: none)

[disable-awslint:ref-via-interface].


throttle?

Type: ThrottlingPerMethod[] (optional, default: none)