AWS CDK Reference

Appearance

v2.273.0

WebSocketStageAttributes Struct ​

The attributes used to import existing WebSocketStage.

Source
aws-apigatewayv2/lib/websocket/stage.ts
Type last changed
v2.112.0 · 1 Dec 2023

Example ​

ts
declare const webSocketApi: apigwv2.IWebSocketApi;

const importedStage = apigwv2.WebSocketStage.fromWebSocketStageAttributes(this, 'imported-stage', {
  stageName: 'myStage',
  api: webSocketApi,
});

const apiKey = new apigwv2.ApiKey(this, 'MyApiKey');

const usagePlan = new apigwv2.UsagePlan(this, 'MyUsagePlan', {
  apiStages: [{ api: webSocketApi, stage: importedStage }],
});

usagePlan.addApiKey(apiKey);

Properties ​

apiIWebSocketApiapiIWebSocketApiapiIWebSocketApiApiIWebSocketApiApiIWebSocketApirequired#
The API to which this stage is associated.
stageNamestringstage_namestrstageNameStringStageNamestringStageName*stringrequired#
The name of the stage.