Skip to content
v2.278.0

WebSocketRouteIntegrationBindOptions Struct ​

Options to the WebSocketRouteIntegration during its bind operation.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const construct: constructs.Construct;
declare const webSocketRoute: apigatewayv2.WebSocketRoute;
const webSocketRouteIntegrationBindOptions: apigatewayv2.WebSocketRouteIntegrationBindOptions = {
  route: webSocketRoute,
  scope: construct,
};
python
# 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
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigatewayv2.*;
import software.constructs.*;

Construct construct;
WebSocketRoute webSocketRoute;

WebSocketRouteIntegrationBindOptions webSocketRouteIntegrationBindOptions = WebSocketRouteIntegrationBindOptions.builder()
        .route(webSocketRoute)
        .scope(construct)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
using Constructs;

Construct construct;
WebSocketRoute webSocketRoute;
var webSocketRouteIntegrationBindOptions = new WebSocketRouteIntegrationBindOptions {
    Route = webSocketRoute,
    Scope = construct
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import constructs "github.com/aws/constructs-go/constructs"

var construct Construct
var webSocketRoute WebSocketRoute

webSocketRouteIntegrationBindOptions := &WebSocketRouteIntegrationBindOptions{
	Route: webSocketRoute,
	Scope: construct,
}

Properties ​

The route to which this is being bound.
scopeConstructscopeConstructscopeConstructScopeConstructScopeConstruct required #
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.