WebSocketRouteIntegrationBindOptions

class aws_cdk.aws_apigatewayv2.WebSocketRouteIntegrationBindOptions(*, route, scope)

Bases: object

(experimental) Options to the WebSocketRouteIntegration during its bind operation.

Parameters:

route (IWebSocketRoute) – (experimental) The route to which this is being bound.
scope (Construct) – (experimental) The current scope in which the bind is occurring. If the WebSocketRouteIntegration being bound creates additional constructs, this will be used as their parent scope.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2
import aws_cdk.core as cdk

# construct: cdk.Construct
# web_socket_route: apigatewayv2.WebSocketRoute

web_socket_route_integration_bind_options = apigatewayv2.WebSocketRouteIntegrationBindOptions(
    route=web_socket_route,
    scope=construct
)

Attributes

route

(experimental) The route to which this is being bound.

Stability:: experimental

scope

(experimental) The current scope in which the bind is occurring.

If the WebSocketRouteIntegration being bound creates additional constructs, this will be used as their parent scope.

Stability:: experimental