@aws-cdk_aws-apigatewayv2-alpha.WebSocketApiAttributes

interface WebSocketApiAttributes ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.WebSocketApiAttributes
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#WebSocketApiAttributes
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.WebSocketApiAttributes
Pythonaws_cdk.aws_apigatewayv2_alpha.WebSocketApiAttributes
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป WebSocketApiAttributes

Attributes for importing a WebSocketApi into the CDK.

Example

const webSocketApi = apigwv2.WebSocketApi.fromWebSocketApiAttributes(this, 'mywsapi', { webSocketId: 'api-1234' });

Properties

NameTypeDescription
webSocketId๐Ÿ”นstringThe identifier of the WebSocketApi.
apiEndpoint?๐Ÿ”นstringThe endpoint URL of the WebSocketApi.

webSocketId๐Ÿ”น

Type: string

The identifier of the WebSocketApi.


apiEndpoint?๐Ÿ”น

Type: string (optional, default: throw san error if apiEndpoint is accessed.)

The endpoint URL of the WebSocketApi.