Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

1.204.0

interface WebSocketStageAttributes 🔹

This page is available in another version. Click here for the v2 documentation.

LanguageType name
.NETAmazon.CDK.AWS.APIGatewayv2.WebSocketStageAttributes
Javasoftware.amazon.awscdk.services.apigatewayv2.WebSocketStageAttributes
Pythonaws_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

NameTypeDescription
api🔹IWebSocketApiThe API to which this stage is associated.
stageName🔹stringThe name of the stage.

api🔹

Type: IWebSocketApi

The API to which this stage is associated.

stageName🔹

Type: string

The name of the stage.

← PreviousNext →