WebSocketApiProps Struct
Props for WebSocket API.
Example
ts
const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi',{
apiKeySelectionExpression: apigwv2.WebSocketApiKeySelectionExpression.HEADER_X_API_KEY,
});
Properties
apiKeySelectionExpressionoptionalWebSocketApiKeySelectionExpressionapi_key_selection_expressionoptionalWebSocketApiKeySelectionExpressionapiKeySelectionExpressionoptionalWebSocketApiKeySelectionExpressionApiKeySelectionExpressionoptionalWebSocketApiKeySelectionExpressionApiKeySelectionExpressionoptionalWebSocketApiKeySelectionExpression#An API key selection expression.
Default: Key is not required to access these APIs
Providing this option will require an API Key be provided to access the API.
apiNameoptionalstringapi_nameoptionalstrapiNameoptionalStringApiNameoptionalstringApiNameoptional*string#Name for the WebSocket API resource.
Default: id of the WebSocketApi construct.
connectRouteOptionsoptionalWebSocketRouteOptionsconnect_route_optionsoptionalWebSocketRouteOptionsconnectRouteOptionsoptionalWebSocketRouteOptionsConnectRouteOptionsoptionalWebSocketRouteOptionsConnectRouteOptionsoptionalWebSocketRouteOptions#Options to configure a '$connect' route.
Default: no '$connect' route configured
defaultRouteOptionsoptionalWebSocketRouteOptionsdefault_route_optionsoptionalWebSocketRouteOptionsdefaultRouteOptionsoptionalWebSocketRouteOptionsDefaultRouteOptionsoptionalWebSocketRouteOptionsDefaultRouteOptionsoptionalWebSocketRouteOptions#Options to configure a '$default' route.
Default: no '$default' route configured
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= none#The description of the API.
disableSchemaValidationoptionalbooleandisable_schema_validationoptionalbooldisableSchemaValidationoptionalBooleanDisableSchemaValidationoptionalboolDisableSchemaValidationoptional*bool= false#Avoid validating models when creating a deployment.
disconnectRouteOptionsoptionalWebSocketRouteOptionsdisconnect_route_optionsoptionalWebSocketRouteOptionsdisconnectRouteOptionsoptionalWebSocketRouteOptionsDisconnectRouteOptionsoptionalWebSocketRouteOptionsDisconnectRouteOptionsoptionalWebSocketRouteOptions#Options to configure a '$disconnect' route.
Default: no '$disconnect' route configured
ipAddressTypeoptionalIpAddressTypeip_address_typeoptionalIpAddressTypeipAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressType#The IP address types that can invoke the API.
Default: undefined - AWS default is IPV4
routeSelectionExpressionoptionalstringroute_selection_expressionoptionalstrrouteSelectionExpressionoptionalStringRouteSelectionExpressionoptionalstringRouteSelectionExpressionoptional*string= '$request.body.action'#The route selection expression for the API.