interface WebSocketApiAttributes
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.APIGatewayv2.WebSocketApiAttributes |
Java | software.amazon.awscdk.services.apigatewayv2.WebSocketApiAttributes |
Python | aws_cdk.aws_apigatewayv2.WebSocketApiAttributes |
TypeScript (source) | @aws-cdk/aws-apigatewayv2 » WebSocketApiAttributes |
Attributes for importing a WebSocketApi into the CDK.
Example
const webSocketApi = apigwv2.WebSocketApi.fromWebSocketApiAttributes(this, 'mywsapi', { webSocketId: 'api-1234' });
Properties
Name | Type | Description |
---|---|---|
web | string | The identifier of the WebSocketApi. |
api | string | The 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.