interface WebSocketStageAttributes
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGatewayv2.WebSocketStageAttributes |
 Java | software.amazon.awscdk.services.apigatewayv2.WebSocketStageAttributes |
 Python | aws_cdk.aws_apigatewayv2.WebSocketStageAttributes |
 TypeScript (source) | @aws-cdk/aws-apigatewayv2 » WebSocketStageAttributes |
The attributes used to import existing WebSocketStage.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
declare const webSocketApi: apigatewayv2.WebSocketApi;
const webSocketStageAttributes: apigatewayv2.WebSocketStageAttributes = {
api: webSocketApi,
stageName: 'stageName',
};
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.