interface WebSocketStageAttributes
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Apigatewayv2.WebSocketStageAttributes |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#WebSocketStageAttributes |
 Java | software.amazon.awscdk.services.apigatewayv2.WebSocketStageAttributes |
 Python | aws_cdk.aws_apigatewayv2.WebSocketStageAttributes |
 TypeScript (source) | aws-cdk-lib » aws_apigatewayv2 » WebSocketStageAttributes |
The attributes used to import existing WebSocketStage.
Example
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
| Name | Type | Description |
|---|---|---|
| api | IWeb | The API to which this stage is associated. |
| stage | string | The name of the stage. |
api
Type:
IWeb
The API to which this stage is associated.
stageName
Type:
string
The name of the stage.