interface UsagePlanPerApiStage

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

Represents the API stages that a usage plan applies to.

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
api?	IWebSocketApi	The WebSocket API to associate with the usage plan.
stage?	IWebSocketStage	[disable-awslint:ref-via-interface].

---

api?

Type: IWebSocketApi (optional, default: none)

The WebSocket API to associate with the usage plan.

---

stage?

Type: IWebSocketStage (optional, default: none)

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