WebSocketRouteIntegrationBindOptions

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

Bases: object

Options to the WebSocketRouteIntegration during its bind operation.

Parameters:
  • route (IWebSocketRoute) – The route to which this is being bound.

  • scope (Construct) – 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.

ExampleMetadata:

fixture=_generated

Example:

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

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

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

Attributes

route

The route to which this is being bound.

scope

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.