interface UsagePlanProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.UsagePlanProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#UsagePlanProps
Java	software.amazon.awscdk.services.apigatewayv2.UsagePlanProps
Python	aws_cdk.aws_apigatewayv2.UsagePlanProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » UsagePlanProps

Properties for defining an API Gateway Usage Plan for WebSocket APIs.

Example

const api = new apigwv2.WebSocketApi(this, 'my-api');
const stage = new apigwv2.WebSocketStage(this, 'my-stage', {
  webSocketApi: api,
  stageName: 'dev',
});

const usagePlan = new apigwv2.UsagePlan(this, 'my-usage-plan', {
  usagePlanName: 'Basic',
});

usagePlan.addApiStage({
  api: api,
  stage: stage,
});

Properties

Name	Type	Description
apiStages?	UsagePlanPerApiStage[]	API Stages to be associated with the usage plan.
description?	string	Represents usage plan purpose.
quota?	QuotaSettings	Number of requests clients can make in a given time period.
throttle?	ThrottleSettings	Overall throttle settings for the API.
usagePlanName?	string	Name for this usage plan.

---

apiStages?

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

API Stages to be associated with the usage plan.

---

description?

Type: string (optional, default: none)

Represents usage plan purpose.

---

quota?

Type: QuotaSettings (optional, default: none)

Number of requests clients can make in a given time period.

---

throttle?

Type: ThrottleSettings (optional, default: none)

Overall throttle settings for the API.

---

usagePlanName?

Type: string (optional, default: none)

Name for this usage plan.